Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/statamic/docs
Statamic Documentation
https://github.com/statamic/docs
cms documentation flat-file hacktoberfest laravel php
Last synced: 2 days ago
JSON representation
Statamic Documentation
- Host: GitHub
- URL: https://github.com/statamic/docs
- Owner: statamic
- License: other
- Created: 2019-08-29T17:47:34.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T19:40:45.000Z (9 days ago)
- Last Synced: 2024-10-29T21:40:10.843Z (9 days ago)
- Topics: cms, documentation, flat-file, hacktoberfest, laravel, php
- Language: PHP
- Homepage: https://statamic.dev
- Size: 23.5 MB
- Stars: 115
- Watchers: 14
- Forks: 382
- Open Issues: 68
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
## Statamic Documentation
This is the source of the official [Statamic docs][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](https://laravel.com/docs/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](https://statamic.dev) 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][contribution] 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](https://github.com/statamic/cms/wiki/Code-of-Conduct).
## Important Links
- [Statamic Main Site](https://statamic.com)
- [Statamic Documentation][docs]
- [Statamic CMS Repo][cms-repo] (that we maintain)
- [Statamic Application Repo][app-repo] (that you clone)
- [Statamic Migrator](https://github.com/statamic/migrator)
- [Statamic Discord][discord]
[docs]: https://statamic.dev/
[discord]: https://statamic.com/discord
[contribution]: https://github.com/statamic/cms/blob/master/CONTRIBUTING.md
[app-repo]: https://github.com/statamic/statamic
[cms-repo]: https://github.com/statamic/cms