Quick Start
This guide assumes you have npm or Yarn installed on your machine. Both works, but yarn is recommended.
Installation
Doconuxt is essentially just a NuxtJS application, and the set up is similar.
-
Create and change into a new directory:
mkdir <project-name> cd <project-name>
-
Initialise with your package manager:
yarn init # npm init
-
Install
nuxt
anddoconuxt
:yarn add -D nuxt doconuxt # npm install -D nuxt doconuxt
-
In the
package.json
, add the following scripts:package.json{ // ... "scripts": { "dev": "nuxt", "generate": "nuxt generate", "start": "nuxt start" }, // ... }
-
Create a
nuxt.config.js
file in the root directory and importdoconuxt
:nuxt.config.jsimport doconuxt from "doconuxt"; export default doconuxt;
-
Create a
content/
directory in the root of your project (this is where the Markdown files reside in)
Directory structure example
<project-name>
├── content
│ └── index.md
├── nuxt.config.js
├── package.json
└── yarn.lock # package-lock.json
Start writing
To start writing, make sure you have a content/
directory in the root of your project for your Markdown files.
Create a content/index.md
file and fill it with some Markdown:
# Hello World!
This is `doconuxt`.
Then, start your development server:
yarn dev # npm run dev
If all goes well, you should be able to open up http://localhost:3000, and enjoy instantaneous updates whenever you save your changes.
Read on to learn how page routing works, or how to configure the side navigation bar.