README.en-US.md

English | 简体中文

Smart-Press

• Fast and efficient Markdown website making tool
• Based on Vue3.0 SSR technology

Weixin

Getting Started

Manually

# install 
npm install smarty-press -g

# start to writing 
spress start

# build to html
spress build

Development

# clone first
npm link
cd demo
spress start

yarn add [email protected]

Plugin Development

seededicated section in docs.

Subject library

MarkDown

http://zhongce.sina.com.cn/article/view/18867

The menu template

• default： AdminLTE
• todo:
  • Menu free configuration function

Documentation

Usage

• Step. 1 Create and change into a new directory.

mkdir hello-smarty-press && cd hello-smarty-press

• Step. 2 Initialize with your preferred package manager.

yarn init

• Step. 3 Install smarty-press locally (if you already install by global, can skip this step)

yarn add --dev smarty-press

• Step. 4 create README.md file

touch README.md

• Step. 5 write content to README.md

# How to use SmartyPress
## Install

## Usage

• Step. 6 Add some scripts to package.json (if install by global，you can skip this step)

{
  "scripts": {
    "start": "spress start",
    "build": "spress build"
  }
}

• Step. 7 start local server

yarn start

if install by global，you should use the following command

spress start

• Step. 8 building The Docs

yarn build

if install by global，you should use the following command

spress build