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

[WIP] Proof of concept - Make the docs part of the Gatsby website #1

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lindapaiste
Copy link

This is something I'm playing around with. I don't know if it makes sense to do this. Docsify has some nice features (search and sidebar) but also some limitations.

I did:

  • Copy .md files from docsify repo
  • Add "frontmatter" to some .md files, specifying the URL path and title
  • Get Gatsby to load these files as pages (There's a mix of two approaches right now, where one works for some pages but not others)

I did not:

  • Copy the CSS styles from Docsify
  • Recreate the Docsify sidebar
  • Implement a search feature
  • Embed images and iframes
  • Add frontmatter to every page

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.

1 participant