目录
折叠 | 展开

Links

When creating links, you can use standard HTML or Markdown formatting. However, you can also implement an automated approach to linking that makes linking much less error-prone (meaning less chances of broken links in your output) and requiring less effort.

Create an external link

When linking to an external site, use Markdown formatting because it’s simplest:

[Google](http://google.com)

Linking to internal pages

When linking to internal pages, you can manually link to the pages like this:

[Icons](mydoc_icons.html)

However, if you change the file name, you’ll have to update all of your links. It’s much easier to use Automated links, as described in the next section.

Automated links

This method for automated links creates a master list of all links in a Markdown reference format based on entries in your sidebar table of contents.

With this Automated links method, make sure all your pages are referenced in a sidebar or topnav data file (inside _data > sidebars). If they’re not in a sidebar or top nav (such as links to headings on a page), list them in the other.yml file (which is in the _data/sidebars folder).

The links.html file (in _includes) will iterate through all your sidebars and create a list of reference-style markdown links based on the url properties in the sidebar items.

Note: For the automated links method to work, each of your pages must have a permalink property in the frontmatter. The permalink property must match the file name. For example, if the file name is somefile.html, your permalink property would be somefile.html. See [Pages][mydoc_pages] for more details.

To implement managed links:

In your _config.yml file, list each sidebar in the sidebars property — including the other.yml file too:
```
sidebars:
- home_sidebar
- mydoc_sidebar
- product1_sidebar
- product2_sidebar
- other
```
At the bottom of each topic where you plan to include links, include the links.html file:
```
{% include links.html %}
```
To link to a topic, use reference-style Markdown links, with the referent using the file name (without the file extension). For example:
```
See the [Icon][mydoc_icons] file.
```
Here’s the result:

See the [Icon][mydoc_icons] file.

If the link doesn’t render, check to make sure the page is correctly listed in the sidebar.

Automated links to headings on pages

If you’re linking to the specific heading from another page, first give the heading an ID:

## Some heading {#someheading}

Then add a property into the other.yml file in your _data/sidebars folder:

    - title: Some link bookmark
      url: /mydoc_pages.html#someIdTag

And reference it like this:

This is [Some link][mydoc_pages.html#someIdTag].

Result:

This is [Some link][mydoc_pages.html#someIdTag].

It’s a little strange having the .html# in a reference like this, but it works.

orzh-introduction

nginx-lua-module-zh-wiki

orzh-introduction

nginx-lua-module-zh-wiki

p1_landing_page

p2_landing_page

p1_landing_page

xwaf_installation

xwaf_advanced_readme

xwaf_getting_started

xwaf_faqs_readme

nginx-lua-module-zh-wiki

orange_api_server

orange_build_plugin

orange_dashboard_usage

orange_basic_auth

orange_basic_info

orange_key_auth

orange_rate_limiting

orange_redirect

orange_condition

orange_expression

orange_extraction

orange_extractor

orange_contributing

add_new_lua_api

how_request_http

install_on_centos

install_on_ubuntu

install_on_windows

work_with_location

call_user_func_array

control_structrues

function_before_use

function_define

function_descrip

function_parameter

function_result

object_oriented

time_date_function

pra_flame_install

pra_ngx_lua_allow_deny

pra_ngx_lua_block_io

pra_ngx_lua_cache

pra_ngx_lua_capture

pra_ngx_lua_continue_after_eof

pra_ngx_lua_debug

pra_ngx_lua_ffi

pra_ngx_lua_hot_load

pra_ngx_lua_how_one_instance_time

pra_ngx_lua_how_use_third_lib

pra_ngx_lua_keepalive

pra_ngx_lua_log

pra_ngx_lua_lua-limit

pra_ngx_lua_lua_opt

pra_ngx_lua_lua-variable-scope

pra_ngx_lua_on_abort

pra_ngx_lua_phase

pra_ngx_lua_resolve_the_domain_name

pra_ngx_lua_shared_get_keys

pra_ngx_lua_sleep

pra_ngx_lua_timer

pra_ngx_lua_use_case

pra_ngx_lua_whats_cosocket

pra_redis_auth_connect

pra_redis_dynamic_redis_module_method

pra_redis_out_package

pra_redis_pipeline

pra_redis_pub_sub_package

pra_redis_script

pra_redis_select-keeplive

pra_postgres_health_check

pra_postgres_how_to_use

pra_postgres_not_support_transaction

pra_postgres_sql_inject

pra_postgres_timeout

pra_nginx_balancer

pra_nginx_co-work_of_location

pra_nginx_if_is_evil

pra_nginx_match_uri

pra_nginx_nginx_brief

pra_nginx_nginx_local_pcre

pra_nginx_nginx_log

pra_nginx_nginx

pra_nginx_pitfalls_and_common_mistakes

pra_nginx_reverse_proxy

pra_nginx_static_file

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_scan_port

candylab_common_sites_log_system

candylab_graylog_clickhouse

candylab_clickhouse_basic

candylab_logs_and_gateway

candylab_sec_system_arch

candylab_logs_dsl_waf

candylab_opensock_list

candylab_opensock_practice

candylab_opensock_email

candylab_base_on_openresty_waf

candylab_dsl_waf

candylab_honeypot_system

candylab_monitor_redis

candylab_threat_replay

candylab_pcap_monitor

candylab_monitor_website

candylab_openrestyplus_waf

candylab_windows_bigdata

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

candylab_clickhouse_basic

mydoc_hyperlinks.html#automatedlinks

mydoc_hyperlinks.html#bookmarklinks

mydoc_pages.html#someIdTag

nginx-lua-module-zh-wiki

nginx-development-guide-zh

Tags: