W3C home > Mailing lists > Public > public-credentials@w3.org > September 2020

Weekend Project: ReSpec GitHub Pages

From: Orie Steele <orie@transmute.industries>
Date: Sun, 20 Sep 2020 18:37:33 -0500
Message-ID: <CAN8C-_+1c0Y1DUU_vCJkS56FNBX4Nh2CPqPWZiQmRMgTRNq-BQ@mail.gmail.com>
To: "W3C Credentials CG (Public List)" <public-credentials@w3.org>
Made a GitHub Template repository that makes technical specification
development with ReSpec even easier:

https://github.com/transmute-industries/respec-github-pages

New Features

- Support for GitHub Markdown and HTML
- Automatic SEO / feed / sitemap support in XML (including schema.org /
jsonld)
- Guidance for hosting JSON files alongside spec text.
- Support for multiple versions that can share the same configuration files
- Support for multiple Specs that can share the same configuration files
- Relies on GitHub Pages, so documentation for "how to do things" is
already provided by them.
- No need to "build the spec" like is needed with bikeshed, github does
this for you, and automatically notifies you when it's done (no workflows
or CI needed).

Dependencies

Just uses ReSpec and GitHub.... so there is no "source code"... it's just a
configuration of free existing tooling.

If you really need to, you can edit 100% of the source files in the github
repo, just like you had to before...
If you don't need to configure ReSpec, you don't need to even see it, and
you can use markdown to quickly sketch your spec up.

I opened an issue on respec, trying to find a better home for the repo /
template.

Not sure where it belongs, but hopefully some other github organization
with more maintainers : )

OS

-- 
*ORIE STEELE*
Chief Technical Officer
www.transmute.industries

<https://www.transmute.industries>
Received on Sunday, 20 September 2020 23:37:57 UTC

This archive was generated by hypermail 2.4.0 : Thursday, 24 March 2022 20:25:03 UTC