Pages will be "hidden" unless linked to directly. Navigation and will not be included in the previous and next links. Included with the built site, however, they will not be linked from the global While sections may mirror your directory structure, they do not have to.Īny pages not listed in your navigation configuration will still be rendered and Users to navigate through the site navigation by over-complicating the nesting. However, be careful that you don't make it too difficult for your Sections are onlyĬontainers for child pages and sub-sections. Note that a section cannot have a page assigned to it. Guide" section two pages are listed: "Writing your docs" and "Styling yourĭocs." Under the "About" section two more pages are listed: "License" and With the above configuration we have three top level items: "Home", "User Guide"Īnd "About." "Home" is a link to the homepage for the site. 'Styling your docs': 'styling-your-docs.md' 'Writing your docs': 'writing-your-docs.md' Navigation sub-sections can be created by listing related pages together under a
Used throughout the site for that page and will override any title defined Note that if a title is defined for a page in the navigation, that title will be In the nav setting add a title right before the filename. If no title is defined within the file, of the file name. Level and with their titles inferred from the contents of the Markdown file or, The above example will result in two navigation items being created at the top Source files for the above configuration would be located at docs/index.md and If that option is set to the default value, docs, the Will need to manually define your navigation configuration if you would likeĪ minimal navigation configuration could look like this: nav:Īll paths in the navigation configuration must be relative to the docs_dirĬonfiguration option. (except that index files will always be listed first within a sub-section). Navigation configuration will always be sorted alphanumerically by file name If not provided, the navigation will beĪutomatically created by discovering all the Markdown files in theĭocumentation directory. The nav configuration setting in your mkdocs.yml fileĭefines which pages are included in the global site navigation menu as well as If both an index.md file and a README.md file are found in the sameĭirectory, then the index.md file is used and the README.md file is Renamed to index.html so that the server will serve it as a proper index file. However, when MkDocs renders your site, the file will be Source code, the repository host can display the index page of that directory as In that way, when users are browsing your Therefore, MkDocs will allow you to name your index pages as Many repository hosting sites provide special treatment for README files byĭisplaying the contents of the README file when browsing the contents of aĭirectory. Index.md, which MkDocs will render to index.html when building the site. When a directory is requested, by default, most web servers will return an indexįile (usually named index.html) contained within that directory if one exists.įor that reason, the homepage in all of the examples above has been named
YOUR DOCS IN DENTON MD HOW TO
How to link to images and media below for details. Within the documentation directory are copied by Source files inside nested directories will cause pages to be generated withĪny files which are not identified as Markdown files (by their file extension) You can also include your Markdown files in nested directories if that better Given the above layout, pages would be generated for the following URLs: / The file layout you use determines the URLs that are used for the generated You can also create multi-page documentation, by creating several Markdown This can be overridden with the exclude_docs config. Files and directories with names which begin with a dot (for example.
0 kommentar(er)
