{"id":13819125,"url":"https://github.com/w3cub/docshub","last_synced_at":"2025-05-16T04:32:39.180Z","repository":{"id":40405665,"uuid":"47599993","full_name":"w3cub/docshub","owner":"w3cub","description":"API Documentation Browser based Github Pages Service","archived":false,"fork":false,"pushed_at":"2024-01-22T12:20:58.000Z","size":111,"stargazers_count":77,"open_issues_count":9,"forks_count":10,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-19T18:46:30.969Z","etag":null,"topics":["devdocs","docshub","documentation","github-page","github-pages","jekyll","ruby","ruby-script","w3cubdocs"],"latest_commit_sha":null,"homepage":"https://docs.w3cub.com/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/w3cub.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-12-08T05:10:13.000Z","updated_at":"2024-10-13T19:55:55.000Z","dependencies_parsed_at":"2024-01-22T14:24:09.669Z","dependency_job_id":null,"html_url":"https://github.com/w3cub/docshub","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w3cub%2Fdocshub","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w3cub%2Fdocshub/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w3cub%2Fdocshub/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w3cub%2Fdocshub/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/w3cub","download_url":"https://codeload.github.com/w3cub/docshub/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254469550,"owners_count":22076518,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["devdocs","docshub","documentation","github-page","github-pages","jekyll","ruby","ruby-script","w3cubdocs"],"created_at":"2024-08-04T08:00:40.770Z","updated_at":"2025-05-16T04:32:34.505Z","avatar_url":"https://github.com/w3cub.png","language":"Shell","funding_links":[],"categories":["Happy Exploring 🤘"],"sub_categories":[],"readme":"\n# Docshub\nW3cubDocs API Documentation - [W3cubDocs](http://docs.w3cub.com/)\n\n\n## Submodules\n\n```md\n./   \n├── [devdocs](https://github.com/w3cub/devdocs/) # Origin project   \n├── [docslogo](https://github.com/w3cub/docslogo/) # Generate logos for index page\n└── [website](https://github.com/w3cub/docsgen/) # Jekyll project , which we need to convert static pages\t\n```  \n\n## Configure File\n\n\n.genlist\n\nYou've added the documention list. Additionally, the `index page` will be generated based on this file.\nRelated task: `copy_json`, `sortgenlist`\n\n\n.genonly\n\nAt the current time, you only need to generate the documentions list.\nRelated task: `copy_json`, `sortgenonly`, `generate_html`. if you need to regenerate the documention list, you need to clean up the `.history` file first.\n\n\n.history \n\nThe history file is used to record the documentions list that has been generated. \nRelated task: `generate_html`.\n\n\n\n\n## Usage\n\n```shell\nsudo apt install curl nodejs\n\n# firewall user  \n\nexport http_proxy=http://127.0.0.1:1080 \u0026\u0026 export https_proxy=$http_proxy \u0026\u0026 export ALL_PROXY=$http_proxy\n\n# rvm\n\n\\curl -sSL https://get.rvm.io | bash -s stable\n\nrvm install 3.3.0\ngit clone --recursive git@github.com:icai/docshub.git\ncd docshub \n\ncd ./devdocs \ngem install bundler\nbundle install\n\nthor docs:download --all # download all file\n\nthor sprites:generate\n\ncd ..\ncd ./docslogo\nsudo apt-get install imagemagick graphicsmagick\nnpm install -d\ngulp sprite\n\n\ncd ..\n\n# dev test\n\n# try diff and synchronize the javascript, image and stylesheet files\n\nbundle install\nrake copy_json # generate all json files\nrake copy_all # to copy the other file\n    # - rake copy_icons # copy docslogo icons to website\n    # - rake copy_json # generate all json files\nrake copy_test # generate all file to website\ncd ./website\nrake erb # icon file\nrake test_preview\n\n# deploy test\nbundle install\n\n#  change .genlist and .genonly file first\nrake copy_json # generate all json files\n\n#  example: rake generate_html openjdk~21\nrake generate_html # generate jekyll base(sand) document\n\n# update docslogo project first and devdocs project run thor sprites:generate\n\nrake copy_icons # copy docslogo icons to website\nrake copy_json # generate all json files\nrake copy_allhtml # generate all file to website\ncd ./website\nrake test_preview\n```\n\n## Release\n\n```shell\ncd ./website\nrake badlink # output badlink url, you need to add in the `_config.yml` file `include` options \nrake erb\nrake setup_gen  # [option] setup generate queue\nrake setup_genonly  # [option] setup generate only queue\nrake gitinit # [option]\nrake multi_gen_deploy # project release\nrake sitemap  # generate sitemap\nrake push\n```\n\n\n## Deploy New Server\n\n```sh\n\n# nginx\n\nwget https://raw.githubusercontent.com/w3cub/docshub/master/deploy/nginx.sh -O nginx.sh \\\n\u0026\u0026 mkdir -p /opt/deploy \u0026\u0026 cd /opt/deploy  \\\n\u0026\u0026 wget https://raw.githubusercontent.com/w3cub/docshub/master/deploy/gsync.sh -O sync.sh\n\n```\n\n## Deploy OpenResty Server\n\n\n```sh\nwget https://raw.githubusercontent.com/w3cub/docshub/master/deploy/deploy.sh -O deploy.sh \u0026\u0026 chmod +x deploy.sh\n\n./deploy.sh\n\n```\n\n\n\n```sh\n\nwget https://raw.githubusercontent.com/w3cub/docshub/master/deploy/openresty.sh -O openresty.sh \u0026\u0026 chmod +x openresty.sh\n\n./openresty.sh\n\n# download www file \n\nmkdir -p /opt/deploy \u0026\u0026 cd /opt/deploy\n\nwget https://raw.githubusercontent.com/w3cub/docshub/master/deploy/gsync.sh -O sync.sh \u0026\u0026 chmod +x sync.sh\n\n./sync.sh\n\n# network\n\nwget https://raw.githubusercontent.com/w3cub/docshub/master/deploy/network.sh -O network.sh \u0026\u0026 chmod +x network.sh\n\n./network.sh\n\n\n# download openresty conf\n\nwget https://raw.githubusercontent.com/w3cub/docshub/master/deploy/conf.sh -O conf.sh \u0026\u0026 chmod +x conf.sh\n\n./conf.sh\n\n```\n\n\n\n\n## License\n\nThis software is licensed under the terms of the Mozilla Public License v2.0. \n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fw3cub%2Fdocshub","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fw3cub%2Fdocshub","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fw3cub%2Fdocshub/lists"}