diff options
| author | Nicolas Paul <n@nc0.fr> | 2023-04-27 00:09:29 +0200 |
|---|---|---|
| committer | Nicolas Paul <n@nc0.fr> | 2023-04-27 00:09:29 +0200 |
| commit | e73ab4a851989e8f0dcfbb0a52c4ad75f63883da (patch) | |
| tree | 079d874fb7d4d55e9148f5bf0fa8934c5f2e4070 /doc/src/index.md | |
| parent | a2a376fe38157ee111a9ce3070179f9951672f87 (diff) | |
Add more detailled documentation
Diffstat (limited to 'doc/src/index.md')
| -rw-r--r-- | doc/src/index.md | 36 |
1 files changed, 5 insertions, 31 deletions
diff --git a/doc/src/index.md b/doc/src/index.md index dcd98b0..ecd8d0a 100644 --- a/doc/src/index.md +++ b/doc/src/index.md @@ -14,6 +14,7 @@ keywords: - website - simple publication_time: 2023-04-26T19:05:00Z +publication_time: 2023-04-27T00:08:00Z author: Nicolas Paul <n@nc0.fr> --- # Crocc @@ -39,38 +40,11 @@ $ go install go.nc0.fr/crocc@latest ## Usage -Let's say you have a directory containing the following files: +See the [example](/example) for a simple example of a Crocc website. -``` -src/ -├── .crocc.html -├── index.md -├── about.md -├── bar.png -└── contact.md -``` - -The `.crocc.html` file is the template used to generate the HTML pages. -The `index.md`, `about.md` and `contact.md` files are Markdown documents. -The `bar.png` file is a static file. - -To generate the HTML files, run the following command: - -```bash -$ crocc -out=dst -url="http://example.com" src -``` - -The `dst` directory will contain the following files: - -``` -dst/ -├── index.html -├── about.html -├── bar.png -└── contact.html -``` - -You can now upload the `dst` directory to your web server and you're done! +A more concrete project is +[this website itself](https://github.com/n1c00o/crocc/tree/master/doc), which +is built with Crocc. ## Documentation |