# fantasyjs-doc

**Repository Path**: limaofeng/fantasyjs-doc

## Basic Information

- **Project Name**: fantasyjs-doc
- **Description**: No description available
- **Primary Language**: CSS
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2015-04-20
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 该文档仿 Semantic Docs 实现

# 注意
模块eco在 server/documents文件夹下
### 启动
```
docpad run
http://localhost:9778
```

##  左侧菜单列表
修改 sidebar.html.eco
<% jsList         = @getCollection("documents").findAll({type: $in: ['JS LIST']},[{title: 1}]).toJSON() %>
jsList用来循环菜单子项
JS LIST
list\view.html.eco
---
layout      : 'default'
css         : 'site'
element     : 'site'
elementType : 'list'

title       : '列表首页'
description : 'A site is a set of global constraints that define the basic parameters of all UI elements'
type        : 'JS LIST'
themes      : ['Default', 'Material']

---

































# Semantic Docs

This folder contains the templates used to generate the static website for [semantic-ui.com](http://www.semantic-ui.com)

## How to Use


To install [DocPad](http://github.com/docpad/docpad), the static site generator used to create the html for the site.
```
npm install -g docpad
docpad install eco;
docpad update; docpad upgrade;
```

### Generating SUI for Docs

Before running server you will need to build your UI files for the docs. Semantic UI includes a special command to build files for a docs instance that must be run from an adjacent Semantic UI folder.
for example with a directory vendor -> SemanticUI place docs folder inside vendor to reflect vendor -> SemanticUI | docs

```
# assumes ./docs and ./ui for default paths, run from ./ui (the folder name ./ui may be any folder that contains the Semantic UI build files)
# run gulp build-docs from the folder containing Semantic UI this will build docs into the sibling folder ./docs
gulp build-docs
```

> The default location for ``build-docs`` is an adjacent folder with the name ``docs/``. The command must be run from your UI folder and not from the docs folder.

To configure a different docs location modify [ tasks/docs.json](https://github.com/Semantic-Org/Semantic-UI/blob/master/tasks/admin/docs.json)


### Running Server

You can then start your docs server (and generate docs) using:
```
#run from inside docs folder that will now contain the compiled docs - windows users can then navigate to http://localhost:9778
docpad run
```

To watch for changes from your ui folder to serve to your docs instance
```
gulp serve-docs
```


## Help Fix Typos and Errors

If you find any typos or mistakes, submitting a fix is easy!

[Open the documents folder](https://github.com/Semantic-Org/Semantic-UI-Docs/tree/master/server/documents) on GitHub, click the edit button on the appropriate page. Then click to submit a pull request.