This is the source of the official Statamic 3 Beta docs.
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:
- Fork this repository
- Open your terminal and cd to your
~/Sitesfolder - Clone your fork into the
~/Sites/docsfolder, by running the following command with your username placed into the {username} slot: git clone [email protected]:{username}/docs statamic-docs - CD into the new directory you just created.
- Run the following commands:
composer install
npm install
npm run dev
cp .env.example .env
php artisan key:generate
Statamic 3 is now in open beta! We welcome you try it out, read the docs, experiment, send bug reports, provide thoughtful feedback, and otherwise do anything you feel will make the platform better and more stable for launch.
If this is your first experience with Statamic, please reserve your final judgement until we're out of beta. We've built a solid and flexible foundation and most bugs and rough edges should be minor efforts to address.
Statamic 3 has extensive (in progress) documentation, and this is the repo for them. We dedicate a significant amount of time and energy every day to improving them, so if something is unclear, wait a day or two and check back again. If it's still confusing, feel free to open an issue or chat with us on Discord about it!
Thank you for considering contributing to Statamic! Please review the contribution guide before you open issues or send pull requests.
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.