Build sitemaps #51
Merged
Build sitemaps #51
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ibgreen
approved these changes
Aug 7, 2018
isaacbrodsky
approved these changes
Aug 7, 2018
| @@ -13,6 +13,7 @@ ocular build-docs | |||
| ``` | |||
|
|
|||
| in the CLI and this will create a mdRoutes file based on the contents of the __/src/docs/__ folder. Each markdown (.md) file will become an entry in the table of content, grouped hierarchically by folders. | |||
| If you have a BASEURL file in your src folder, which contains the url of the your documentation file, ocular build-docs will also generate a sitemap (__sitemap.xml__) based on these files. | |||
There was a problem hiding this comment.
or are using a Github project type
…in jsRoutes. (#56) Previously, jsRoutes was taken as is - there was no reprocessing at all. All routes that needed to appear in the table of contents had to be in mdRoutes. The issue there is that mdRoutes mixed 2 kind of routes - those with documentations (as intended) and those with standalone components. With this PR, we can go back to a model where mdRoutes contains only routes with markdown files (and can easily be generated instead of manually created)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When a user runs ocular build-docs to generate a mdRoutes.js file based on the contents of their /src/docs folder, this will now also create a sitemap.xml file based on these files.
In other words, if the user puts their markdown files in /src/docs, ocular can not only generate a dynamic routes js file but also the corresponding sitemap.xml document so search engines can index the contents of these pages.