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(site): build new documentation site #787

Closed
4 tasks done
redonkulus opened this issue Apr 6, 2020 · 1 comment
Closed
4 tasks done

feat(site): build new documentation site #787

redonkulus opened this issue Apr 6, 2020 · 1 comment
Assignees

Comments

@redonkulus
Copy link
Contributor

redonkulus commented Apr 6, 2020

Goals

  • The goal is to rebuild the Purecss.io site on Docusaurus with as little changes as possible.
  • Migrate off Zeit as v1 is EOL this summer. Purecss.io doesn't work on Zeit v2.

Background

This PR adds a new documentation site for Pure with Docusaurus. The existing site is built on old versions of Express, Handlebars, Broccoli and other custom libraries that are no longer supported. I've tried to upgrade the code, but there is so much to untangle that it's easier to build an entirely new site using newer technologies.

When looking to build a new site, I wanted something that did not require a server. This would help reduce server cost and maintenance. The current site is hosted on Zeit and cannot be upgraded to Zeit v2 without refactoring the code to work with newer versions of Nodejs. Furthermore, Pure is built for browsers and lends itself to work with static site generators very well.

I checked out a few different options (Jekyll ~ didn't want to build it in markdown, Gatsby ~ promising but complex), but settled on Docusaurus for its ease of use, readability and my own familiarity with React. React is probably a bit over engineered for a simple static site, but it's a nice language to work in, even if it's just a static site. Plus, at build time we can generate a fully static site and remove React entirely if need be.

Deployment

My plan is to deploy the static site to Github Pages and serve it from there. Nothing better than free!

Development

The site will exist within this repository and be developed against the latest version of Pure that is checked into the repository. Because the site is co-located with the Pure codebase, it will be easier to develop, test and deploy the site all at once time. The existing pure-site repository will be archived once the migration is complete.

TODO

This will be a running list of things to complete before it is ready for production:

  • Migrate existing pages
  • Migrate examples
  • Deploy to GitHub Pages
  • Update purecss.io to point to GitHub Pages Zeit for now.

Please let me know if there are any other questions or concerns.

@redonkulus
Copy link
Contributor Author

The new doc site is now served from the site/ directory.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant