feat(landing): add GitHub Pages landing page - #168
Merged
Merged
Conversation
Static one-page site in site/, deployed to GitHub Pages by .github/workflows/pages.yml on pushes to master that touch site/, gh-md-toc, or the workflow. The version shown on the page comes from ./gh-md-toc --version at deploy time.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds a static landing page for gh-md-toc on GitHub Pages:
https://ekalinin.github.io/github-markdown-toc/
site/index.html,site/styles.css: one English page with Installation, Why,Usage, Auto insert and update TOC, GitHub Actions, GitHub token, Docker, and
Windows sections. The sidebar TOC is gh-md-toc's own output for the page's
headings.
.github/workflows/pages.yml: deployssite/on pushes tomasterthat touchsite/**,gh-md-toc, or the workflow. The version on the page comes from./gh-md-toc --version.inline script; without JavaScript the page is fully readable.
Examples show the current output of 0.10.0. Remote examples use a wiki URL because
of #166. README updates are tracked in #165, lint warnings in #167.
Before merge
Enable Pages with Source "GitHub Actions" (Settings -> Pages).