docs: remove default pages
This commit is contained in:
parent
69cb40ec80
commit
547644795d
@ -14,7 +14,7 @@ repo_url = "https://git.clan.lol/clan/"
|
||||
[[extra.menu.main]]
|
||||
name = "Docs"
|
||||
section = "docs"
|
||||
url = "/docs/getting-started/introduction/"
|
||||
url = "/docs/overview"
|
||||
weight = 10
|
||||
|
||||
[[extra.menu.main]]
|
||||
|
@ -1,10 +0,0 @@
|
||||
+++
|
||||
title = "Getting Started"
|
||||
description = "Quick start and guides for installing the AdiDoks theme on your preferred operating system."
|
||||
date = 2025-05-01T08:00:00+00:00
|
||||
updated = 2021-05-01T08:00:00+00:00
|
||||
template = "docs/section.html"
|
||||
sort_by = "weight"
|
||||
weight = 1
|
||||
draft = false
|
||||
+++
|
@ -1,31 +0,0 @@
|
||||
+++
|
||||
title = "Introduction"
|
||||
description = "AdiDoks is a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme Doks for Zola."
|
||||
date = 2021-05-01T08:00:00+00:00
|
||||
updated = 2021-05-01T08:00:00+00:00
|
||||
draft = false
|
||||
weight = 10
|
||||
sort_by = "weight"
|
||||
template = "docs/page.html"
|
||||
|
||||
[extra]
|
||||
lead = 'AdiDoks is a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme <a href="https://github.com/h-enk/doks">Doks</a> for Zola.'
|
||||
toc = true
|
||||
top = false
|
||||
+++
|
||||
|
||||
## Quick Start
|
||||
|
||||
One page summary of how to start a new AdiDoks project. [Quick Start →](../quick-start/)
|
||||
|
||||
## Go further
|
||||
|
||||
Contributing and Help.
|
||||
|
||||
## Contributing
|
||||
|
||||
Find out how to contribute to Doks. [Contributing →](../../contributing/how-to-contribute/)
|
||||
|
||||
## Help
|
||||
|
||||
Get help on Doks. [Help →](../../help/faq/)
|
@ -1,94 +0,0 @@
|
||||
+++
|
||||
title = "Quick Start"
|
||||
description = "One page summary of how to start a new AdiDoks project."
|
||||
date = 2021-05-01T08:20:00+00:00
|
||||
updated = 2021-05-01T08:20:00+00:00
|
||||
draft = false
|
||||
weight = 20
|
||||
sort_by = "weight"
|
||||
template = "docs/page.html"
|
||||
|
||||
[extra]
|
||||
lead = "One page summary of how to start a new AdiDoks project."
|
||||
toc = true
|
||||
top = false
|
||||
+++
|
||||
|
||||
## Requirements
|
||||
|
||||
Before using the theme, you need to install the [Zola](https://www.getzola.org/documentation/getting-started/installation/) ≥ 0.15.0.
|
||||
|
||||
## Run the Theme Directly
|
||||
|
||||
```bash
|
||||
git clone https://github.com/aaranxu/adidoks.git
|
||||
cd adidoks
|
||||
zola serve
|
||||
```
|
||||
|
||||
Visit `http://127.0.0.1:1111/` in the browser.
|
||||
|
||||
## Installation
|
||||
|
||||
Just earlier we showed you how to run the theme directly. Now we start to
|
||||
install the theme in an existing site step by step.
|
||||
|
||||
### Step 1: Create a new zola site
|
||||
|
||||
```bash
|
||||
zola init mysite
|
||||
```
|
||||
|
||||
### Step 2: Install AdiDoks
|
||||
|
||||
Download this theme to your themes directory:
|
||||
|
||||
```bash
|
||||
cd mysite/themes
|
||||
git clone https://github.com/aaranxu/adidoks.git
|
||||
```
|
||||
|
||||
Or install as a submodule:
|
||||
|
||||
```bash
|
||||
cd mysite
|
||||
git init # if your project is a git repository already, ignore this command
|
||||
git submodule add https://github.com/aaranxu/adidoks.git themes/adidoks
|
||||
```
|
||||
|
||||
### Step 3: Configuration
|
||||
|
||||
Enable the theme in your `config.toml` in the site derectory:
|
||||
|
||||
```toml
|
||||
theme = "adidoks"
|
||||
```
|
||||
|
||||
Or copy the `config.toml.example` from the theme directory to your project's
|
||||
root directory:
|
||||
|
||||
```bash
|
||||
cp themes/adidoks/config.toml.example config.toml
|
||||
```
|
||||
|
||||
### Step 4: Add new content
|
||||
|
||||
You can copy the content from the theme directory to your project:
|
||||
|
||||
```bash
|
||||
cp -r themes/adidoks/content .
|
||||
```
|
||||
|
||||
You can modify or add new posts in the `content/blog`, `content/docs` or other
|
||||
content directories as needed.
|
||||
|
||||
### Step 5: Run the project
|
||||
|
||||
Just run `zola serve` in the root path of the project:
|
||||
|
||||
```bash
|
||||
zola serve
|
||||
```
|
||||
|
||||
AdiDoks will start the Zola development web server accessible by default at
|
||||
`http://127.0.0.1:1111`. Saved changes will live reload in the browser.
|
Loading…
Reference in New Issue
Block a user