From ac7a83f684642dd593880c72c448c649a6983507 Mon Sep 17 00:00:00 2001 From: jonkaric Date: Thu, 2 Oct 2025 14:31:19 +0100 Subject: [PATCH] Fix READMEs --- README.md | 2 +- export/README.md | 59 ------------------------------------------------ 2 files changed, 1 insertion(+), 60 deletions(-) delete mode 100644 export/README.md diff --git a/README.md b/README.md index 4ca4e186..a902dde0 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ 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 fawn/dok +statamic new mysite fawnsoftware/dok ``` **Installing into an existing site** diff --git a/export/README.md b/export/README.md deleted file mode 100644 index e6b35a93..00000000 --- a/export/README.md +++ /dev/null @@ -1,59 +0,0 @@ -A beautiful documentation starter kit. - -## Features -* Tailwind CSS -* AlpineJS -* Light & Dark theme -* Easily create **new themes** with css variables -* [**Remix Icons**](https://remixicon.com/) used as icons -* Add an unlimited amount of **projects** -* Unlimited **versions** per project -* Fully **accessible** -* Built for **unparralelled loading times** -* Simple progressive **View Transitions** -* **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**. -* **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. - -### 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. - -Content is linked to the Entry using a Computed Value. - -### Styling -Dok comes with a light and dark theme, along with a full set of custom typography styles all using **Tailwind v4**. This means there is **no Tailwind configuration file**, just CSS files. Yay 🎉. - -### Browser support -Dok supports the latest versions of all major browsers. We use progressive enhancement where possible. - -### 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 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. - -```bash -statamic new my-site fawnsoftware/dok -``` - -**Installing into an existing site** -```bash -php please starter-kit:install fawnsoftware/dok -``` -