Skip to content
/ doks Public
forked from thuliteio/doks

Everything you need to build a stellar documentation website. Fast, accessible, and easy to use.

License

Notifications You must be signed in to change notification settings

siyehua/doks

This branch is 74 commits ahead of, 37 commits behind thuliteio/doks:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

author
xuankehuang
Mar 11, 2025
e6d18ef · Mar 11, 2025
Dec 28, 2023
Mar 16, 2024
Apr 18, 2024
Mar 7, 2025
Mar 11, 2025
Jun 23, 2023
May 23, 2024
Jan 11, 2024
Apr 15, 2020
Jan 11, 2024
Mar 1, 2021
Sep 8, 2023
Jun 23, 2023
Apr 18, 2023
Jan 12, 2024
Apr 18, 2023
Jan 11, 2024
Jan 11, 2024
Mar 2, 2024
Jan 11, 2024
Mar 18, 2024
Apr 18, 2024
May 23, 2024
Jan 11, 2024
Mar 2, 2024
Mar 2, 2024
Sep 8, 2023

Repository files navigation

Doks

Doks is a documentation theme for Hyas.

Demo

Install

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.

Install this project

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

Add or Change Content

Main Page

Edit style and css layouts to see this page change.

Edit content content/_index.md to see this page change.

Blog

Add or Edit Markdown files to content to create new pages.

Config

Edit your config in config/_default/hyas/doks.toml

Vercel

todo

Documentation

Visit our official documentation.

add time

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

index.md

title

---
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
---

Support

Having trouble? Get help in the official Doks Discussions.

Contributing

New contributors welcome! Check out our Contributor Guides for help getting started.

Links

Sponsors

Doks is supported by Netlify, Algolia, and several other amazing organizations and inidviduals. Sponsor Doks! ❤️

About

Everything you need to build a stellar documentation website. Fast, accessible, and easy to use.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 83.4%
  • JavaScript 14.9%
  • Shell 1.2%
  • SCSS 0.5%