/svelte-ghblog

Create a simple blog from a GitHub repo using Svelte

Primary LanguageSvelteGNU General Public License v3.0GPL-3.0

svelte-ghblog

For creating a simple blog in a svelte application from a github repository

Try it on StackBlitz

Test workflow Code coverage Github package version Npm package versino Github release Npm downloads Dependencies Vulnerabilites

Roadmap

  • Inital working PoC
  • More customizable interface to render the index (file browser)
  • Finishing setting up commitlint
  • Full test coverage
  • Use zod for schema validation
  • Full documentation/finish readme

Documentation

Until the documentation is completed you can reference the demo folder for how to use.

Installation

# Yarn
yarn add -D @calebgasser/svelte-ghblog

# npm
npm i -D @calebgasser/svelte-ghblog

# pnpm
pnpm i -D @calebgasser/svelte-ghblog

Usage

Until the documentation is completed you can reference the demo folder for how to use.

Examples

Until the documentation is completed you can reference the demo folder for how to use.

Contributing

TODO