Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ By default, we use a simple Vite configuration that comes with every new Statami
Get up and running in an instant with the Statamic CLI tool. This will install a fresh Statamic instance with Dok installed.

```bash
statamic new mysite arrowtide/dok
statamic new mysite fawn/dok
```

**Installing into an existing site**
```bash
php please starter-kit:install arrowtide/dok
php please starter-kit:install fawn/dok
```

2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "arrowtide/dok",
"name": "fawn/dok",
"extra": {
"statamic": {
"name": "Dok",
Expand Down
12 changes: 6 additions & 6 deletions export/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ A beautiful documentation starter kit.
* **Highly customisable** typography styles
* Host your content on **Statamic** or **Github**
* Sync from GitHub, even from multiple **repositories** and **organisations**.
* Sync **manually**, on a **shedule**, or even through a **webhook**.
* Sync **manually**, on a **shedule**, or even through a **webhook**.
* **Permalink** and **Table of contents** markdown extensions preinstalled.
* Shiki for **code highlighting**

### Projects and versions
You can host multiple projects and manage different versions for each project. This is handled through the releases collection. To add a new project or version, simply create a new entry in the collection and configure the required fields.

### Statamic as a content source
Wanna just write markdown directly to Statamic? Yup, you can do that.
Wanna just write markdown directly to Statamic? Yup, you can do that.

### GitHub as a content source
If you'd like to host your documentation within a project repository to keep everything centralized, Dok makes the process simple. All you need is a GitHub Personal Access Token and a small update to your configuration file. Once that's done, you can easily link entries to their corresponding resource paths.
Expand All @@ -38,22 +38,22 @@ Dok supports the latest versions of all major browsers. We use progressive enhan
### Compiling Assets
By default, we use a simple Vite configuration that comes with every new Statamic site when using the CLI tool so you should feel right at home.

`npm run dev` - Watches your content, rebuilds, and refreshes your browser so you can instantly see the changes.
`npm run dev` - Watches your content, rebuilds, and refreshes your browser so you can instantly see the changes.
`npm run build` - Build for production


## Installation

**Installing with Statamic CLI (recommended)**

Get up and running in an instant with the Statamic CLI tool. This will install a fresh Statamic instance with Dok installed.
Get up and running in an instant with the Statamic CLI tool. This will install a fresh Statamic instance with Dok installed.

```bash
statamic new my-site arrowtide/dok
statamic new my-site fawn/dok
```

**Installing into an existing site**
```bash
php please starter-kit:install arrowtide/dok
php please starter-kit:install fawn/dok
```

4 changes: 2 additions & 2 deletions export/content/collections/example_v1/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ updated_at: 1741264233
Get up and running in an instant with the Statamic CLI tool. This will install a fresh Statamic instance with Dok installed.

```shell
statamic new my-site arrowtide/dok
statamic new my-site fawn/dok
```

**Installing into an existing site**
```shell
php please starter-kit:install arrowtide/dok
php please starter-kit:install fawn/dok
6 changes: 3 additions & 3 deletions export/content/collections/example_v1/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ php please stache:refresh
```

## Documentation
We've written fairly detailed documentation for Dok. It should cover everything you need to know to get started. If you think something is missing, please [open an issue](https://github.com/arrowtide/dok/issues/new). We are always looking to improve Dok.
We've written fairly detailed documentation for Dok. It should cover everything you need to know to get started. If you think something is missing, please [open an issue](https://github.com/fawnsoftware/dok/issues/new). We are always looking to improve Dok.

## Issues
If you think something is missing or broken, please [open an issue](https://github.com/arrowtide/dok/issues/new).
If you think something is missing or broken, please [open an issue](https://github.com/fawnsoftware/dok/issues/new).

## Questions? Suggestions?
If you have any questions or suggestions, please open a [discussion](https://github.com/arrowtide/dok/discussions/new).
If you have any questions or suggestions, please open a [discussion](https://github.com/fawnsoftware/dok/discussions/new).
6 changes: 3 additions & 3 deletions export/resources/views/home.antlers.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ <h1 class="text-4xl md:text-5xl text-white mb-5 leading-snug max-w-4xl mx-auto">

<div class="grid sm:grid-cols-2 gap-5 mt-20 max-w-70 sm:max-w-120 mx-auto">
<a class="px-5 py-3 inline-block bg-accent font-medium text-white transition rounded-md hover:bg-accent/90" href="/example/1.x">Get Started</a>
<a class="px-5 py-3 inline-block text-white rounded-md hover:bg-white/5 transition" href="https://statamic.com/starter-kits/arrowtide/dok-documentation" target="_blank">View on Statamic</a>
<a class="px-5 py-3 inline-block text-white rounded-md hover:bg-white/5 transition" href="https://statamic.com/starter-kits/fawn/dok-documentation" target="_blank">View on Statamic</a>
</div>
</header>

Expand Down Expand Up @@ -79,12 +79,12 @@ <h3 class="mb-2 mt-5">{{ title }}</h3>
<div class="text-center">
<div class="prose">
<h2 class="text-4xl">Ready to build your documentation?</h2>
<p>You can find the full documentation on <a href="https://statamic.com/starter-kits/arrowtide/dok-documentation">the marketplace</a>.</p>
<p>You can find the full documentation on <a href="https://statamic.com/starter-kits/fawn/dok-documentation">the marketplace</a>.</p>
</div>

<div class="grid sm:grid-cols-2 gap-5 mt-20 max-w-70 sm:max-w-120 mx-auto">
<a class="px-5 py-3 inline-block bg-accent font-medium text-white transition rounded-md hover:bg-accent/90" href="/example/1.x">Get Started</a>
<a class="px-5 py-3 inline-block text-white rounded-md hover:bg-white/5 transition" href="https://statamic.com/starter-kits/arrowtide/dok-documentation" target="_blank">View on Statamic</a>
<a class="px-5 py-3 inline-block text-white rounded-md hover:bg-white/5 transition" href="https://statamic.com/starter-kits/fawn/dok-documentation" target="_blank">View on Statamic</a>
</div>
</div>
</section>
Expand Down