1.

How Does The Documentation End Up On The Sails Website?

Answer»

The DOCUMENTATION is compiled from the markdown files in the sails-docs repo on GitHub. A number of Sails users have expressed interest in emulating the process we use to generate the PAGES on the Sails website. Good news is it's PRETTY SIMPLE: The compilation process for the Sails docs involves generating HTML from Markdown files in the sails-docs repo, then performing some additional transformations such as adding data type bubbles, tagging permalinks for individual sections of pages, BUILDING JSON data to power the side navigation menu and setting HTMLattributes for better search engine discoverability of individual doc pages.

The documentation is compiled from the markdown files in the sails-docs repo on GitHub. A number of Sails users have expressed interest in emulating the process we use to generate the pages on the Sails website. Good news is it's pretty simple: The compilation process for the Sails docs involves generating HTML from Markdown files in the sails-docs repo, then performing some additional transformations such as adding data type bubbles, tagging permalinks for individual sections of pages, building JSON data to power the side navigation menu and setting HTMLattributes for better search engine discoverability of individual doc pages.



Discussion

No Comment Found