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.

Sign up for GitHub

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

Jump to bottom

Add example mdBook to show off colourscheme #3

Closed
2 of 3 tasks
sgoudham opened this issue Aug 27, 2022 · 2 comments
Closed
2 of 3 tasks

Add example mdBook to show off colourscheme #3

sgoudham opened this issue Aug 27, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Milestone
v0.2.0

Comments

@sgoudham
Copy link
Contributor

sgoudham commented Aug 27, 2022 •
edited

What

An example mdbook should live in the root directory of the repository. This book should also be deployed under GitHub Pages.

Why

Providing a visual preview of the colour scheme will significantly enhance the user experience and offer easy access to the latest version of the extension. We should use the domain mdbook.catppuccin.com

Acceptance Criteria

  • Example mdBook created with pages showcasing different types of highlights (headings, paragraphs, codeblocks etc)
  • GitHub Actions workflow for deploying to GitHub Pages
  • Page deployed under mdbook.catppuccin.com
@sgoudham sgoudham added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Aug 27, 2022
@sgoudham sgoudham added this to the v0.2.0 milestone Aug 27, 2022
@NamesCode
Copy link
Member

Hey, I'm interested in this

@sgoudham
Copy link
Contributor Author

sgoudham commented Sep 2, 2022 •
edited

Thanks for your interest in contributing! Feel free to ping me on discord if you need any help or have any questions, happy to help 👍

sgoudham added a commit that referenced this issue Jun 15, 2023
@sgoudham
feat: add example mdBook
3469e9e 
closes #3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
v0.2.0
Development

No branches or pull requests
2 participants
@sgoudham @NamesCode