All Projects → w3cub → docshub

w3cub / docshub

Licence: MPL-2.0 License
API Documentation Browser based Github Pages Service

Programming Languages

ruby
36898 projects - #4 most used programming language
shell
77523 projects

Projects that are alternatives of or similar to docshub

Reverie
🎨 A ridiculously elegant Jekyll theme.
Stars: ✭ 442 (+662.07%)
Mutual labels:  jekyll, github-pages, github-page
Liberxue.github.io
Liberxue blog for lightweight Jekyll themes 轻量级自适应 简洁 卡片式博客主题 3秒搞定GitHub blog
Stars: ✭ 330 (+468.97%)
Mutual labels:  jekyll, github-pages, github-page
CodeForAfrica.org
The @CodeForAfrica landing page. Built with Jekyll and hosted on Github Pages. Accessible at https://codeforafrica.org/
Stars: ✭ 20 (-65.52%)
Mutual labels:  jekyll, github-pages, github-page
Hanuman
A responsive, lightning-fast Jekyll theme built using AMP (Accelerated Mobile Pages) to speed up your blogs and websites.
Stars: ✭ 100 (+72.41%)
Mutual labels:  jekyll, github-pages, github-page
Slate
Slate is a Jekyll theme for GitHub Pages
Stars: ✭ 195 (+236.21%)
Mutual labels:  jekyll, github-pages
Mm Github Pages Starter
Minimal Mistakes GitHub Pages site starter
Stars: ✭ 191 (+229.31%)
Mutual labels:  jekyll, github-pages
Fastpages
An easy to use blogging platform, with enhanced support for Jupyter Notebooks.
Stars: ✭ 2,888 (+4879.31%)
Mutual labels:  jekyll, github-pages
git clones
Git clone all of a user's PUBLIC Github repositories
Stars: ✭ 20 (-65.52%)
Mutual labels:  github-pages, github-page
Primer
Primer is a Jekyll theme for GitHub Pages
Stars: ✭ 160 (+175.86%)
Mutual labels:  jekyll, github-pages
Millennial
A minimalist Jekyll theme for running an online publication
Stars: ✭ 223 (+284.48%)
Mutual labels:  jekyll, github-pages
BaseMax.Github.io
Max Base Personal Website.
Stars: ✭ 20 (-65.52%)
Mutual labels:  github-pages, github-page
Fast template
A template for really easy blogging with GitHub Pages
Stars: ✭ 184 (+217.24%)
Mutual labels:  jekyll, github-pages
Architect
Architect is a Jekyll theme for GitHub Pages
Stars: ✭ 182 (+213.79%)
Mutual labels:  jekyll, github-pages
markdownslides
A "markdown-first" approach for generating beautiful browser-based slides easily. Based on Reveal.js and Reveal-Jekyll.
Stars: ✭ 37 (-36.21%)
Mutual labels:  jekyll, github-pages
Oscailte
Oscailte — A powerful light, clean, and responsive Jekyll theme.
Stars: ✭ 178 (+206.9%)
Mutual labels:  jekyll, github-pages
Just The Docs
A modern, high customizable, responsive Jekyll theme for documention with built-in search.
Stars: ✭ 3,747 (+6360.34%)
Mutual labels:  jekyll, github-pages
amphp.github.io
Main website repository.
Stars: ✭ 21 (-63.79%)
Mutual labels:  jekyll, github-pages
Phomeme
Simple sentence mixing tool (work in progress)
Stars: ✭ 18 (-68.97%)
Mutual labels:  github-pages, github-page
google-sheet-to-github-website
This is a working project for operating a data driven website on Github Pages using Google Sheets as a data source.
Stars: ✭ 20 (-65.52%)
Mutual labels:  jekyll, github-pages
fuse-core
The 'Fuse Core' Jekyll theme.
Stars: ✭ 29 (-50%)
Mutual labels:  jekyll, github-pages

Docshub

W3cubDocs API Documentation - W3cubDocs

Submodules

./   
├── [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	

Usage

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 "ruby-2.6.5"

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 beauty


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
rake generate_html # generate jekyll base(sand) document
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

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 gitinit # [option]
rake multi_gen_deploy # project release
rake sitemap  # generate sitemap
rake push

Deploy New Server

# 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

License

This software is licensed under the terms of the Mozilla Public License v2.0.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].