Doks is a documentation theme for Hyas.
The recommended way to install the latest version of Doks is by running the command below:
npm create hyas@latest -- --template doks
Looking for help? Start with our Getting Started guide.
clone this project to your disk:
git clone https://github.com/siyehua/doks
install package:
npm install
run
npm run dev
the npm
run will have cache, it will let your website isn't the newest version!!
if you want to run without cache, use this command:
./build_no_cache.sh
Edit style and css layouts
to see this page change.
Edit content content/_index.md
to see this page change.
Add or Edit Markdown files to content
to create new pages.
Edit your config in config/_default/hyas/doks.toml
todo
Visit our official documentation.
Note: If the date
or lastmod
is larger than the current time, it will be not show in the website.
TZ='Asia/Shanghai' date +"%Y-%m-%dT%H:%M:%S%z" | sed 's/\([+-][0-9][0-9]\)\([0-9][0-9]\)/\1:\2/' | pbcopy
---
title: "Example Post4"
description: "Just an example post."
summary: "You can use blog posts for announcing product updates and features."
date: 2023-09-07T16:27:22+02:00 #TZ='Asia/Shanghai' date +"%Y-%m-%dT%H:%M:%S%z" | sed 's/\([+-][0-9][0-9]\)\([0-9][0-9]\)/\1:\2/'
lastmod: 2023-09-07T16:27:22+02:00 #TZ='Asia/Shanghai' date +"%Y-%m-%dT%H:%M:%S%z" | sed 's/\([+-][0-9][0-9]\)\([0-9][0-9]\)/\1:\2/'
draft: false
weight: 49 # The smaller the weight on the page, the more forward the page will be
categories: []
tags: []
contributors: []
pinned: false
homepage: false
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---
Having trouble? Get help in the official Doks Discussions.
New contributors welcome! Check out our Contributor Guides for help getting started.
Doks is supported by Netlify, Algolia, and several other amazing organizations and inidviduals. Sponsor Doks! ❤️