abw / badger-website

Badger Powered Website

Badger Website

Badger Website is a framework / template which I use to generate the documentation websites for various other badger projects.

You're welcome to use it, but please bear in mind that I wrote it for me to get a particular job done. It's a work in progress, lacks documentation and is subject to change without notice.

Documentation Website

See the website for documentation and examples.

https://abw.github.io/badger-website/

Getting Started

Probably best if you don't.

Notes for Maintainers

Check out the repository.

$ git clone https://github.com/abw/badger-website.git
$ cd badger-website

Install the dependencies.

$ pnpm install

To run the development server.

$ pnpm dev

To build for production.

$ pnpm build

To build the documentation.

$ pnpm build:docs

To preview the documentation.

$ pnpm preview

Check source code for formatting errors.

$ pnpm lint

Author

Andy Wardley