Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): generate single-page doc from wiki #94

Merged
merged 76 commits into from Jul 14, 2020
Merged

feat(docs): generate single-page doc from wiki #94

merged 76 commits into from Jul 14, 2020

Conversation

sidvishnoi
Copy link
Member

Plan is to generate (using respec2html) a ~/static/docs/index.html file on a schedule (or manually), which will be served at https://respec.org/docs
The "live" version can be accessed at https://respec.org/docs/src.html (I checked in this branch on server)

Very raw right now, but also pretty solid 😄
Some of the changes in this, mainly markdown processing can be used upsteam also.

ReSpec Documentation
</title>
<script src=
"https://deploy-preview-3007--respec-pr.netlify.app/respec-w3c.js" class=
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

half joking... but maybe we need a new documentation profile..

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

w3c one should be fine I think.. though we don't use many of its features, and maintaining a new profile would be painful by itself.

Copy link
Member

@marcoscaceres marcoscaceres left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coming along really nicely!

@sidvishnoi sidvishnoi marked this pull request as ready for review July 14, 2020 09:16
Copy link
Member

@marcoscaceres marcoscaceres left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!!!!

@sidvishnoi sidvishnoi merged commit 1a03651 into gh-pages Jul 14, 2020
@sidvishnoi sidvishnoi deleted the docs branch July 14, 2020 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants