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

Add script and GitHub action to automatically generate ReSpec versions of the spec #2574

Merged
merged 35 commits into from
May 20, 2021

Conversation

MikeRalphson
Copy link
Member

The GitHub Action raises a PR against thr gh-pages branch when the versions/v*.md files change on the main branch.

@MikeRalphson
Copy link
Member Author

@webron @earth2marsh @ncaidin @rebeccajg updated this PR as discussed in Slack #marketing channel. An additional latest.html file will now be created so we can leave a permanent link in place and hopefully achieve better SEO.

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
@darrelmiller darrelmiller merged commit cc45c37 into OAI:main May 20, 2021
char0n pushed a commit to char0n/OpenAPI-Specification that referenced this pull request Jul 5, 2021
…s of the spec (OAI#2574)

* workflows: update used actions

* .

* bikeshed rendering (WIP)

* bikeshed; split into v2, v3 directories

* bikeshed; fixes to TOC,code blocks and indent levels

* bikeshed; work from unmodified .md files

* bikeshed; .gitignore

* bikeshed; separate header for v3.0.1 for now

* respec; as an alternative to bikeshed

* Rename bikeshed to md2html

* md2html; current setup

* md2html; wip

* md2html; fix 1 toc bug

* md2html; fix another toc bug

* md2html; fix 1 respec toc bug

* md2html; fix another bikeshed toc bug

* respec; former editor support - needs ReSpec 20.x

* Latest respec tweaks

* pre block css background, RFC ref fixes

* Github gist syntax highlighting css

* md2html: move to scripts dir

* md2html: resolve relative links for examples

* md2html: use respec js from spec.openapis.org site

* md2html: find gist.css regardless of run dir

* md2html: don't mix https and http content (toc)

* md2html; include google analytics

* md2html; build putative versions 4,5 etc

* md2html; tidying up

* md2html; specify lang="en" in html

* build: update deps

* fix: style examples bugs, refs OAI#2488

* fix: update highlightjs call in md2html

* feat: add github action

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>

* build: create a `latest.html` ReSpec version

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
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.

3 participants