brandonoldenhof / docs

Statamic Documentation

Statamic Documentation

This is the source of the official Statamic docs.

Local Development

If you want to work on this project on your local machine, you may follow the instructions below. These instructions assume you are serving the site using Laravel Valet out of your ~/Sites directory:

1. Fork this repository
2. Open your terminal and cd to your ~/Sites folder
3. Clone your fork into the ~/Sites/docs folder, by running the following command with your username placed into the {username} slot: git clone [email protected]:{username}/docs statamic-docs
4. CD into the new directory you just created.
5. Run the following commands:

composer install
npm install
npm run dev
cp .env.example .env
php artisan key:generate

Providing Feedback

We love it when people provide thoughtful feedback! Feel free to open issues on for any content you find confusing or incomplete. We are happy to consider anything you feel will make the docs and CMS better.

Contributing

Thank you for considering contributing to Statamic! Every page in the docs site has a link at the bottom that will take you right to the exact content file that renders the page. Click the edit button and submit those PRs!

We simply ask that you please review the contribution guide before you send pull requests.

Code of Conduct

In order to ensure that the Statamic community is welcoming to all and generally a rad place to belong, please review and abide by the Code of Conduct.

Important Links

• Statamic Main Site
• Statamic Documentation
• Statamic CMS Repo (that we maintain)
• Statamic Application Repo (that you clone)
• Statamic Migrator
• Statamic Discord