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

Docs site #116

Merged
merged 32 commits into from
Dec 2, 2019
Merged

Docs site #116

merged 32 commits into from
Dec 2, 2019

Conversation

kinetifex
Copy link
Contributor

Summary

Apologies for the size of this PR. This tackles a lot, but in short, this enables a docs site for Gasket using GitHub pages.

What is introduced is:

  • Docsify view of the repo
  • Docsify theme for gasket docs
  • Alignment pass of all readme files (primary focus on plugins)

Changelog

repo

  • Alignment pass on markdown files
  • Add site/ files and index.html
    • Use npm run docs-view for local development

@gasket/plugin-docsify

  • Add Gasket theme, set as default
  • Add return to Table of Contents link for docs
  • Add default Prism support for: jsx, json, diff, bash

Test Plan

Browse preview GitHub page in my fork:

Screen Shot 2019-11-26 at 10 37 05 PM

Copy link
Contributor

@DullReferenceException DullReferenceException left a comment

Choose a reason for hiding this comment

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

Looks good to me, just have some nits. I would recommend reviewing these markdown files for proper document outline structure; I pointed out some, but not all cases where the header levels aren't correct.

@kinetifex kinetifex merged commit d915939 into godaddy:canary Dec 2, 2019
kinetifex pushed a commit that referenced this pull request Dec 2, 2019
* [minor] stub out docsify site

* [theme] init simple theme

* [fix] link

* [theme] continued iterations

* [theme] temp repeating bg

* [minor] move and set up gasket theme for docsify plugin

* [theme] update site to pull from docsify plugin

* [docs] readme alignment

* [docs] readme alignment

* [dist] disable oclif generated readme so we can hand-edit better

* [site] iteration on cover page

* [site] fix github logo

* [fix] urls

* [site] iteration

* [site] mobile second

* [site] make the top readme the index

* [site] border angles

* [site] fix border gap

* [site] border slashes

* [site] elements descr

* [site] fix clip-path for safari

* [site] update favicon and use in docs site

* [site] fix external link svgs and css cleanup

* [test] theme and config changes

* [doc] changelog

* [site] tweak stripes size

* [site] point to slack signin app

* [site] style tweaks

* [dist] add extension to license files

* [docs] add/fix license heading with links

* [site] fixup nav issues

* [fix] lock
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.

4 participants