https://github.com/iissnan/theme-next-docs

Documentations for NexT theme
https://github.com/iissnan/theme-next-docs

Last synced: 3 months ago
JSON representation

Documentations for NexT theme

• Host: GitHub
• URL: https://github.com/iissnan/theme-next-docs
• Owner: iissnan
• Created: 2015-07-17T05:08:48.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-04-03T12:34:18.000Z (over 2 years ago)
• Last Synced: 2024-07-16T14:04:31.429Z (4 months ago)
• Language: HTML
• Homepage: http://theme-next.iissnan.com/
• Size: 14.1 MB
• Stars: 166
• Watchers: 13
• Forks: 55
• Open Issues: 163
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [NexT Documentation](http://theme-next.iissnan.com/) [![Build Status](https://travis-ci.org/iissnan/theme-next-docs.svg?branch=master)](https://travis-ci.org/iissnan/theme-next-docs)

这是 NexT 主题文档的源码，仅接受文档相关的问题。如果你有任何关于 NexT 主题的使用问题，请访问 [NexT 主题仓库](https://github.com/iissnan/hexo-theme-next)，谢谢。

This is the repository for **documentations** of NexT theme, it only accepts issues about documentations.

If you have any questions about using NexT, please visit [NexT repository](https://github.com/iissnan/hexo-theme-next), thanks.

----------

Welcome to contribute. Appreciate for any type of contribution。

## Development

### Requirements

1. Node.js. Download [Node.js](https://nodejs.org/en/download/)

2. Gulp Cli. Run `npm install --global gulp-cli`

3. Project Dependencies. Run `npm install`

### Running Up

After all project dependencies have been resolved, run `gulp` in the project root directory to kick off a local server. 

This server (using BrowserSync) will listen on port `3000`, visit `http://localhost:3000` to see the documentations.

### Project Structure

Directory/File | Description |

----------| ------------|

app       | Application main directory which contains documentations and site assets |

 ├── assets| Site assets |

 ├── en    | English documentations |

 ├── templates| Documentation layouts |

 ├── uploads | Images used in documentations |

gulp        | Gulp library |

 ├── dev-server-middleware | Middleware for BrowserSync |

 ├── tasks  | Gulp tasks |

lib         | Application library |

 ├── tags  | Nunjunks tags used in documentations to ease writing |

 ├── configs.js | Parse config from `app/config.yaml` | 

 ├── renderer.js | Nunjunks Renderer |

 ├── utils.js | Various utilities |

webpack     | Webpack configuration for different environments |

 ├── common.js | Webpack configuration for all environments |

 ├── dev.js | Webpack configuration of development |

 ├── pro.js | Webpack configuration of production |

.editorconfig | EditorConfig configuration |

.travis.yml  | Configuration for TravisCI |

bower.json   | Front-end library dependency management |

gulpfile.js  | Gulp tasks definition |

package.json | Package Information |

tsconfig.json | Typescript configuration file |

### Syntax Highlight Support of WebStorm for Nunjucks Template

To make WebStorm to recognize Nunjucks templates, follow the following steps:

1. Install `Twig` Plugin from JetBrains Plugin Repository.

    ![Install Twig Plugin](install-twig.png "Install Twig Plugin")

    

2. Add Nunjucks template extension to the `Twig` file type.

    ![Add File Type](install-twig-register.png "Add File Type")

    

    In this repo, `.njk` extension is used for Nunjucks Template, so add it to the `Registered Pattern`.