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

Migrate docs to new framework #1

Closed
11 of 12 tasks
davestewart opened this issue Sep 24, 2023 · 4 comments
Closed
11 of 12 tasks

Migrate docs to new framework #1

davestewart opened this issue Sep 24, 2023 · 4 comments
Labels
feature A brand new feature

Comments

@davestewart
Copy link
Contributor

davestewart commented Sep 24, 2023

Background

The docs are currently written in Pug and built as HTML:

There are various issues:

  • editing the docs is hard
  • publishing new docs is currently concatenating spaces between tags

I've got the build working, done some initial cleanup (links, ads, sponsorship links, version, install page) which will do, but it would be nice (though not a necessity) to migrate to a modern markdown-driven docs framework.

Proposal

Convert source files:

  • assess feasibility
  • convert docs (script / package)
  • check / fix examples

Theme:

  • combination of VitePress + Spectre
  • copy images
  • review styling anomalies
  • fix styling anomalies
  • check and fix theme incompatibilities (see Migration fixes #4)

Build:

  • choose framework
  • rebuild docs + examples
  • publish on Netlify / vercel / github pages
  • implement search (Agolia, or such like)
@davestewart
Copy link
Contributor Author

davestewart commented Sep 24, 2023

Making good progress on converting the docs from HTML to Markdown, using some custom scripts and packages:

image

@davestewart
Copy link
Contributor Author

davestewart commented Sep 24, 2023

Things are going well with VitePress! Didn't expect to have 90% of it done already.

image

image

image

@davestewart
Copy link
Contributor Author

OK; see docs repo here:

@davestewart davestewart transferred this issue from spectre-org/spectre-css Sep 25, 2023
@davestewart
Copy link
Contributor Author

New docs are live

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

Successfully merging a pull request may close this issue.

1 participant