https://github.com/techquery/create-hexo-wiki
Wiki-site generator based on Hexo & Git
https://github.com/techquery/create-hexo-wiki
generator git hexo npm website wiki
Last synced: 8 months ago
JSON representation
Wiki-site generator based on Hexo & Git
- Host: GitHub
- URL: https://github.com/techquery/create-hexo-wiki
- Owner: TechQuery
- License: agpl-3.0
- Created: 2019-01-16T12:31:38.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-25T18:40:53.000Z (over 2 years ago)
- Last Synced: 2025-04-15T09:44:12.767Z (11 months ago)
- Topics: generator, git, hexo, npm, website, wiki
- Language: TypeScript
- Homepage: https://tech-query.me/create-hexo-wiki/
- Size: 204 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: ReadMe.md
- License: LICENSE
Awesome Lists containing this project
README
# Hexo Wiki
**Wiki-site** generator based on [Hexo][1] & [Git][2].
[][4]
[][5]
[][6]
## Basic Usage
### 1. Choose a Theme & Plugins
- https://hexo.io/themes/
- You should find out which pages must be created to enable some layout of chosen theme
- https://hexo.io/plugins/ ([Some plugins][7] have been included)
### 2. Create a Git repository
https://github.com/new
### 3. Install Hexo-wiki
```Shell
npm init hexo-wiki create repo_name \
--theme name \
--pages blog,tags \
--plugins one,two \
--remote https://github.com/your_id/repo_name.git
```
### 4. Setup Online services
- [Static Pages host](https://pages.github.com/)
- [Auto updater](https://github.com/marketplace/travis-ci) ([Environment varibles][8])
### 5. Upload whole site
```Shell
git push
```
## Advanced Arguments
create-hexo-wiki create
Create a Hexo Wiki project
Options:
-h, --help show Help information
-P, --pages Required pages of installed theme
-p, --plugins Plugins to install (comma separated)
-r, --remote Git URL of a Remote repository
-t, --theme A theme to install
## Reference Documents
- [Tutorial](https://shimo.im/docs/PcIvVWp7Ok8qnb5X)
- [Source code](https://github.com/TechQuery/create-hexo-wiki)
[1]: https://hexo.io/
[2]: https://git-scm.com/
[3]: https://developers.google.com/web/progressive-web-apps/
[4]: https://david-dm.org/TechQuery/create-hexo-wiki
[5]: https://travis-ci.com/EasyWebApp/create-hexo-wiki
[6]: https://nodei.co/npm/create-hexo-wiki/
[7]: https://github.com/TechQuery/create-hexo-wiki/blob/master/template/package.json#L13
[8]: https://tech-query.me/development/hello-hexo-travis/