Nut17

About this site: Doks

Intro

Doks

This website uses Doks framework which is fast, easy, modern, well documented from the Thulite framework. Visit Doks website to know more. Doks uses markdown files is use for page writing, with convinience of Hugo’s template shortcode to adds more functionality to the markdown file contents.

Thulite

Thulite is an open sourced web framework designed for speed, security, and SEO — all powered by Hugo and npm. Visit Thulite website to know more. Thulite includes everything you need to create a website, built-in. There is also a growing number of different integrations and themes available to customize a project to your exact use case and needs. Thulite also have tutorials to deploy websites.

Hugo

Hugo is a static site generator written in Go. Coded in Go, a modern and efficient langugage gives advantages of secure and fast in developement. Hugo has a huge community and well documentated site. Other than that, its well structured project allows efficient organization and developement. Visit Hugo website to know more.

Doks Feature

Shortcode

Shortcode is a feature from Hugo to provide feature elements like creating a link-card

{{<  card-grid >}}
    {{< link-card title="Shortcode Docs" href="https://getdoks.org/docs/basics/shortcodes/" >}}
    {{< link-card title="Deploy Docs" href="https://docs.thulite.io/guides/deploy/" >}}
{{< /card-grid >}}

Callout blocks are indicated using {{< callout context="tip" title="Tips" icon="outline/rocket" >}}{{< /callout >}} to wrap your content, and can be of type note, tip, caution or danger like shown below.

Tips

This is a callout

Shortcode Docs
Deploy Docs

Diagram

Doks uses diagram generated by Kroki. Mermaid diagrams are popular for making diagram.

Mermaid Ganttdiagram
```kroki {type=mermaid}
gantt
    title A Gantt Diagram
    dateFormat YYYY-MM-DD
    section Section
        A task          :a1, 2014-01-01, 30d
        Another task    :after a1, 20d
    section Another
        Task in Another :2014-01-12, 12d
        another task    :24d
```
Mermaid ERDdiagram
```kroki {type=mermaid}
---
title: Order example
---
erDiagram
    CUSTOMER ||--o{ ORDER : places
    ORDER ||--|{ LINE-ITEM : contains
    CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
```
Mermaid Flow Diagramdiagram
```kroki {type=mermaid}
---
title: Level-1 DFD
---
flowchart TD
    user@{ shape: stadium, label: "Customer (user)" }
    admin@{ shape: stadium, label: "Admin" }
    db@{ shape: lin-rect, label: "Database" }

    data@{ shape: subproc, label: "1 Get Data: user, product, cart, etc..." }
    check@{ shape: subproc, label: "2 Check Order" }
    err@{ shape: subproc, label: "3 Send Error Message (比如商品數量不足)" }
    purchase@{ shape: subproc, label: "4 Purchase" }
    control@{ shape: subproc, label: "Control Process" }

    user-- request -->data
    user-- order -->check

    data-- query -->db
    db-- result -->data
    data-- response -->user

    check-- status data -->err
    err-- error data -->user

    check-- query -->db
    db-- result -->check
    check-- purchase data -->purchase

    purchase-- add purchase -->db
    purchase-- invoice -->user

    admin-- control -->control
    control-- query -->db
    db-- result -->control
    control-- response -->admin
```
D2diagram
```kroki {type=d2}

# Blocks
a: First
b: Second

group1: {
  c: Third
  d: Forth
  c -> d
}

a -> b
b <-> group1.c: Two-sided

# Arrow
group1.d -> a

```

Authoring Notes

Start creating new pages in the /content folder by running this command

npm run create about/index.md

Run the developement server at working directory and the result will be hosted on http://localhost:1313 by running this command

hugo server

For content navbar arrangement, lower weight results in higher position

DocsStarting Weight
Web101
Java201
Dev301

To enable other device viewing the localhost part, enable Firewall Exception on the port 1313 by going to the Control Panel → System and Security → Windows Defender Firewall → Advanced Settings. Then, make sure to allow hugo server listening on all IP by

hugo server --bind 0.0.0.0 --baseURL http://<host IP address>:1313
Edit this page on GitHub
Next
Markdown