Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/w3cub/docshub
API Documentation Browser based Github Pages Service
https://github.com/w3cub/docshub
devdocs docshub documentation github-page github-pages jekyll ruby ruby-script w3cubdocs
Last synced: 3 months ago
JSON representation
API Documentation Browser based Github Pages Service
- Host: GitHub
- URL: https://github.com/w3cub/docshub
- Owner: w3cub
- License: mpl-2.0
- Created: 2015-12-08T05:10:13.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-01-22T12:20:58.000Z (10 months ago)
- Last Synced: 2024-05-28T12:51:37.566Z (5 months ago)
- Topics: devdocs, docshub, documentation, github-page, github-pages, jekyll, ruby, ruby-script, w3cubdocs
- Language: Shell
- Homepage: https://docs.w3cub.com/
- Size: 108 KB
- Stars: 75
- Watchers: 4
- Forks: 10
- Open Issues: 9
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- Open-Source-Ruby-and-Rails-Apps - docshub - API Documentation Browser based Github Pages service 🔥 (Happy Exploring 🤘)
README
# Docshub
W3cubDocs API Documentation - [W3cubDocs](http://docs.w3cub.com/)
## Submodules
```md
./
├── [devdocs](https://github.com/w3cub/devdocs/) # Origin project
├── [docslogo](https://github.com/w3cub/docslogo/) # Generate logos for index page
└── [website](https://github.com/w3cub/docsgen/) # Jekyll project , which we need to convert static pages
```
## Configure File
.genlist
You've added the documention list. Additionally, the `index page` will be generated based on this file.
Related task: `copy_json`, `sortgenlist`
.genonly
At the current time, you only need to generate the documentions list.
Related task: `copy_json`, `sortgenonly`, `generate_html`. if you need to regenerate the documention list, you need to clean up the `.history` file first.
.history
The history file is used to record the documentions list that has been generated.
Related task: `generate_html`.
## Usage
```shell
sudo apt install curl nodejs
# firewall user
export http_proxy=http://127.0.0.1:1080 && export https_proxy=$http_proxy && export ALL_PROXY=$http_proxy
# rvm
\curl -sSL https://get.rvm.io | bash -s stable
rvm install 3.3.0
git clone --recursive [email protected]:icai/docshub.git
cd docshub
cd ./devdocs
gem install bundler
bundle install
thor docs:download --all # download all file
thor sprites:generate
cd ..
cd ./docslogo
sudo apt-get install imagemagick graphicsmagick
npm install -d
gulp sprite
cd ..
# dev test
# try diff and synchronize the javascript, image and stylesheet files
bundle install
rake copy_json # generate all json files
rake copy_all # to copy the other file
# - rake copy_icons # copy docslogo icons to website
# - rake copy_json # generate all json files
rake copy_test # generate all file to website
cd ./website
rake erb # icon file
rake test_preview
# deploy test
bundle install
# change .genlist and .genonly file first
rake copy_json # generate all json files
# example: rake generate_html openjdk~21
rake generate_html # generate jekyll base(sand) document
# update docslogo project first and devdocs project run thor sprites:generate
rake copy_icons # copy docslogo icons to website
rake copy_json # generate all json files
rake copy_allhtml # generate all file to website
cd ./website
rake test_preview
```
## Release
```shell
cd ./website
rake badlink # output badlink url, you need to add in the `_config.yml` file `include` options
rake erb
rake setup_gen # [option] setup generate queue
rake setup_genonly # [option] setup generate only queue
rake gitinit # [option]
rake multi_gen_deploy # project release
rake sitemap # generate sitemap
rake push
```
## Deploy New Server
```sh
# nginx
wget https://raw.githubusercontent.com/w3cub/docshub/master/deploy/nginx.sh -O nginx.sh \
&& mkdir -p /opt/deploy && cd /opt/deploy \
&& wget https://raw.githubusercontent.com/w3cub/docshub/master/deploy/gsync.sh -O sync.sh
```
## Deploy OpenResty Server
```sh
wget https://raw.githubusercontent.com/w3cub/docshub/master/deploy/deploy.sh -O deploy.sh && chmod +x deploy.sh
./deploy.sh
```
```sh
wget https://raw.githubusercontent.com/w3cub/docshub/master/deploy/openresty.sh -O openresty.sh && chmod +x openresty.sh
./openresty.sh
# download www file
mkdir -p /opt/deploy && cd /opt/deploy
wget https://raw.githubusercontent.com/w3cub/docshub/master/deploy/gsync.sh -O sync.sh && chmod +x sync.sh
./sync.sh
# network
wget https://raw.githubusercontent.com/w3cub/docshub/master/deploy/network.sh -O network.sh && chmod +x network.sh
./network.sh
# download openresty conf
wget https://raw.githubusercontent.com/w3cub/docshub/master/deploy/conf.sh -O conf.sh && chmod +x conf.sh
./conf.sh
```
## License
This software is licensed under the terms of the Mozilla Public License v2.0.