[Proposal] Automatically generate GH page

[josh-hemphill]

While GitHub automatically renders the PDF stored in the repo under the corresponding version directory. It would be nice to have a linked GitHub page that automatically loads and renders from the available markdown.
This would decrease the friction of trying to find/read/reference a specific section without downloading files or scrolling forever through a pdf in a subdirectory.

Though I suppose if this were to be done, it would be preferable to render it to page for the OWASP site like is done for the WSTG.

The simplest option might just be to have a static HTML file that uses docsify to dynamically load all the markdown.
Or if indexability and speed are worth the additional complexity, a github action could be set up to statically generate the page with its content.

[jmanico]

Absolutely I want this too! Although my main contribution as an ASVS leader is to hassle people in comments like this, I do believe we have existing automation to do document generation already - and to add a new theme for HTML generation for GitHub pages shouldn’t be that difficult.

…

-- Jim Manico @manicode

On Jan 15, 2021, at 6:14 AM, Josh ***@***.***> wrote:  While GitHub automatically renders the PDF stored in the repo under the corresponding version directory. It would be nice to have a linked GitHub page that automatically loads and renders from the available markdown. This would decrease the friction of trying to find/read/reference a specific section without downloading files or scrolling forever through a pdf in a subdirectory. The simplest option might just be to have a static HTML file that uses docsify to dynamically load all the markdown. Or if indexability and speed are worth the additional complexity, a github action could be set up to statically generate the page with its content. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or unsubscribe.

[sanmai-NL]

Suggestion for library: https://rust-lang.github.io/mdBook/

[tghosth]

I like this idea but it is a non-trivial change. I am open to suggestions and PoCs on how to achieve this.

[cmlh]

Can we leverage http://help.leanpub.com/en/articles/4868811-getting-started-using-leanpub-s-git-and-github-writing-mode-to-write-a-book-tl-dr-version who OWASP have used to publish hard copies in the past?

Also https://www.gitbook.com/ may be an alternative if GitHub Pages or LeanPub is unsuitable?

[jefmeijvis]

As we had the need for an online browsable and linkable ASVS 4.0.3, we created one over at cornucopia.dotnetlab.eu/taxonomy/ASVS-4.0.3.
Figured it might be of use to some people.

Also related to my question at duplicate thread #1624 Online browsable ASVS.

[tghosth]

Interesting thanks for letting us know

[elarlang]

Just for the information, it is not an "official page" nor part of the GitHub action, but I have one output at https://asvs.dev/