Skip to content

Latest commit

 

History

History
18 lines (11 loc) · 1.19 KB

CONTRIBUTION.md

File metadata and controls

18 lines (11 loc) · 1.19 KB
Raw

Contribution

How do I add content?

All the content is written in markdown (.md) and grouped as blog or projects in the content directory. All the default markdown syntax will work. You also have a few example custom markdown elements like YouTube embed, Twitter embed, etc. You can create your own custom components too in two easy steps.

  1. Add a markdoc config. Check out the markdoc config in src/lib/markdoc/config.ts to learn how to add custom components.
  2. Add a component to render your custom component. Check out the Renderer in src/components/Renderer.astro.

How do I make it my blog?

  • All content is static and everything is straight forward. Change whatever you need to change.
  • Delete or update the content in content/{content-group}. content-group could be blog, projects or anything.
  • (Optional) If you need more content types like Notes, just create a new dir in content and add a new frontmatter validator like src/lib/markdoc/blog/frontmatter.

How do I deploy?

yarn build will generate a static website in dist dir. I host it with Netlify.