Skip to content

motionVector/docs-starter-kit

 
 

Repository files navigation

Starter Kit: Documentation

Statamic 3.0+

Features

Screenshot

Screenshot

Quick Start

1. Create a new site

You can create a new site using the Statamic CLI Tool:

statamic new my-new-docs-site doublethreedigital/docs-starter-kit

2. Make a new user

The above installers should prompt you to make a user, but you can also run php please make:user. You'll want it to be a super so you have access to everything.

3. Recompile the CSS (optional)

The TailwindCSS included in this kit is compiled with PurgeCSS to reduce filesize on any unused classes and selectors. If you want to modify anything, just recompile it.

npm i && npm run dev

To compile for production again:

npm run production

4. Do your thing!

If you're using Laravel Valet (or similar), your site should be available at http://my-new-docs-site.test. You can access the control panel at http://my-new-docs-site.test/cp and login with your new user. Open up the source code, follow along with the Statamic 3 docs, and enjoy!

Contributing

Contributions are always welcome! No matter how large or small. Before contributing, please read through the contributor guide. Thanks!

About

Statamic Starter Kit for beautiful documentation.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 72.5%
  • CSS 15.2%
  • JavaScript 7.5%
  • PHP 4.8%