Skip to content

Latest commit

 

History

History
163 lines (104 loc) · 2.49 KB

readme.md

File metadata and controls

163 lines (104 loc) · 2.49 KB

Manual

1. Data File

  • The markdown data file used to define the page is placed under file/;
  • In the data file, # CONFIG is the configuration content, and the other heading 1 is the page content;
  • file/config.md is the default configuration file;
  • file/default.md is the default page file;
  • file/xxx.md is other page file;
  • The content in the data file has higher priority than the configuration file;

2. Configuration Item

2.1. Website Name

## name

website name

2.2. Page Title

## title

page title

Title priority from low to high:

  1. # CONFIG ## title in Config.md;
  2. # {title} of the page content in file/xxx.md;
  3. # CONFIG ## title of the configuration content in file/xxx.md;

2.3. Favicon

## icon

`image/f.ico`

2.4. Page Keywords

## keywords

markdown website md web site

2.5. Rendering Mode

## mode

ucp

Optional items:

  • ucp
  • text 默认;

2.6. Header

## header

### logo

![logo](image/logo.png)

### nav

- [all](index.php)
- [ucp](index.php?f=ucp)
- [text](index.php?f=text)

Demo

2.7. Ending

## ending

### left-1

**demo**

- [ucp](index.php?f=ucp)
- [text](index.php?f=text)

### left-2

**config**

- [config](index.php?f=config)

### left-3

**config detail**

- [header](index.php?f=header)
- [footer](index.php?f=footer)
- [ending](index.php?f=ending)

### left-4

**ucp detail**

- [page](index.php?f=page)
- [unit](index.php?f=unit)
- [card](index.php?f=card)
- [pop](index.php?f=pop)

### right

Build a website by markdown files  

Demo

2.8. Footer

## footer

---
Copyright © 2021 [forw.cc](http://forw.cc)   
All rights reserved 

Demo

3. Access Specific Data File

  • ?f={filename}
  • ?f={dir}/{filename}

4. Rendering Mode

4.1. ucp

Render in unit/card/pop (ucp) mode:

Markdown Web
h1 html head title
h1 content page description
h2 unit
h2 content unit description
h3 card
h3 content card description
h4 pop
h4 content pop description

Demo

4.2. text

Demo