Skip to content

Markdown 腳本架構

Kevin Cyu edited this page Nov 23, 2017 · 3 revisions

回中文 wiki 文檔首頁

Markdown 腳本支援

Simple Example here:

# title
- docoGen markdown support

# options
- type:article
- version:v1.0.0

# author
- name: kevin
    - email: [email protected]
    - phone: 091234567
    - website: https://kevin.imslab.org
- name: ku
    - email: [email protected]
    - phone: 091234567
    - website: https://lu.imslab.org

# abstract
- sentence 1
- sentence 2
- sentence 3

# article
(introduce down below)

# reference
- name: kevin
    - content: NCKU student

article 的細節

  • 這部份會用簡單的範例做展示說明
  • 透過範例引導使用者如何使用 docoGen 定義的 markdown 格式
  • 並再最後一部份說明一個比較大的巢狀架構該如何撰寫

注意! 格式如 name:value 的,在區隔符號 : 的前後不能加上任何空白! 否則會有錯誤發生、或是產生不對的文件格式

text and none

- article
    - title:Text format demo
    - priority:-1
    - content
        - name:None type demo
        - type:none
        - data
            - sentence 1
            - sentence 2
    - content
        - name:Text type demo
        - type:text
        - data
            - sentence 1
            - sentence 2

list

- article
    - title:List format demo
    - priority:0
    - content
        - name:list type demo
        - type:list
        - data
            - list 1
            - list 2
                - list 2-1
                    - list 2-1-1
                    - list 2-1-2
                - list 2-2
            - list 3
            - list 4

table

- article
    - title:Table format demo
    - priority:1
    - content
        - name:table type demo
        - type:table
        - data
            - User Name
                - Kevin
                - Lu
                - Eric
            - Age
                - 20
                - 22
                - 31
            - Job
                - Student
                - Engineer
                - Programmer

formula

- article 
    - title:Formula format demo
    - priority:2
    - content
        - name:formula type demo
        - type:formula
        - data
            - block
                - info:A simple equation!
            - block
                - inline:\(x^2 + y^2 = z^2\)
            - block
                - display:\[x^n + y^n = z^n\]
            - block
                - equation:E=mc^2

code

  • now support both relative and absolute path!
- article
    - title:Code format demo
    - priority:3
    - content
        - name:code type demo
        - type:code
        - data
            - block
                - lang:C
                - caption:Simple Demo C program
                - raw:#include<stdio.h>\n\nint main(){\n\treturn 0;\n}\n
            - block
                - lang:Python
                - flag:rel
                - caption:Simple Demo Python program
                - src:../code/example.py
            - block
                - lang:C
                - caption:Absolute Example
                - src:<your absolute file path!>

figure (inside mode)

- article
    - title:Figure format demo
    - priority:4
    - content
        - name:figure type demo
        - type:figure
        - data
            - block
                - path:../images/ToolBuddy-logo.png
                - flag:rel
                - align:center
                - size:0.5
                - caption:toolbuddy

web-restful-api

- article
    - title:Restful API Support
    - priority:5
    - content
        - name:restful-api type demo
        - type:web-restful-api
        - data
            - block
                - method:post
                - usage:[Online] Register New User
                - url:https://kevin.imslab.org/register
                - description:Enroll new user to local service
                - field
                    - param
                        - name:username
                        - type:string
                    - param
                        - name:username
                        - type:string    
                - error
                    - duplicated
                    - internal error
                - success 
                    - passed
                    - noped

figure (outside mode) and subarticle

- article
    - title:Outside Figure + SubArticle Test
    - priority:6
    - content
        - name:Text Default
        - type:text
        - data
            - sentence 3
            - sentence 4
        - figure
            - block
                - path:../images/ToolBuddy-logo.png
                - flag:rel
                - align:center
                - size:0.5
                - caption:caption of image
            - block
                - path:../images/ToolBuddy-logo.png
                - flag:rel
                - align:center
                - size:0.5
                - caption:caption of image
        - subarticle
            - article
                - title:Nested
                - content
                    - name:Nested Text
                    - type:text
                    - data
                        - sentence nested 1
                        - sentence nested 2
                - content
                    - name:Nested None
                    - type:none
                    - data
                        - sentence nested 3
                        - sentence nested 4
                    - figure
                        - block
                            - path:../images/ToolBuddy-logo.png
                            - flag:rel
                            - align:center
                            - size:0.5
                            - caption:caption of image
                        - block
                            - path:../images/ToolBuddy-logo.png
                            - flag:rel
                            - align:center
                            - size:0.5
                            - caption:caption of image
                    - subarticle
                        - article
                            - title:Nested Nested
                            - content
                                - name:Nested Nested Text
                                - type:text
                                - data
                                    - sentence nested nested 1
                                    - sentence nested nested 2
Clone this wiki locally