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: add website using vocs.dev #57

Closed
wants to merge 5 commits into from
Closed

feat: add website using vocs.dev #57

wants to merge 5 commits into from

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Jan 30, 2024

TODOs

  • OPTION (A): use frontmatter in a typescript object to render titles for markdown, etc.
  • also use (A) for using frontmatter in the index page
  • OPTION (B): add script to turn frontmatter into markdown
  • OPTION (C): use javascript component that turns frontmatter into html
  • allow script to check that frontmatter is already in markdown
  • if frontmatter is already in markdown, do not add it unless the frontmatter has changed
  • do not create duplicate frontmatter in markdown
  • add an index page

Overview

This PR adds a site built with vocs.dev, which is using React + Vite.

Preview of frontmatter automation:
Screenshot 2024-01-29 at 8 01 34 PM

Preview of CIP-1:
Screenshot 2024-01-29 at 8 04 41 PM

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

@jcstein
Copy link
Member Author

jcstein commented Jan 30, 2024

🚢
Screenshot 2024-01-29 at 8 25 22 PM

Light mode previews:
Screenshot 2024-01-29 at 9 23 39 PM

Screenshot 2024-01-29 at 9 23 32 PM

@jcstein jcstein mentioned this pull request Jan 30, 2024
5 tasks
@jcstein jcstein closed this Feb 6, 2024
@jcstein jcstein deleted the jcs/add-vocs branch February 21, 2024 11:00
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