{"id":16598233,"url":"https://github.com/jacksu/zeppelinhub-documentation","last_synced_at":"2026-03-07T16:31:03.189Z","repository":{"id":78681735,"uuid":"52450251","full_name":"jacksu/zeppelinhub-documentation","owner":"jacksu","description":"New ZeppelinHub Documentation Website - ","archived":false,"fork":false,"pushed_at":"2016-02-24T07:05:30.000Z","size":4883,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-14T08:44:18.109Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://help.zeppelinhub.com/","language":"HTML","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jacksu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-24T14:54:53.000Z","updated_at":"2016-02-24T14:54:54.000Z","dependencies_parsed_at":"2023-04-09T05:48:20.971Z","dependency_job_id":null,"html_url":"https://github.com/jacksu/zeppelinhub-documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jacksu/zeppelinhub-documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacksu%2Fzeppelinhub-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacksu%2Fzeppelinhub-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacksu%2Fzeppelinhub-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacksu%2Fzeppelinhub-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jacksu","download_url":"https://codeload.github.com/jacksu/zeppelinhub-documentation/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacksu%2Fzeppelinhub-documentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30221501,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T14:02:48.375Z","status":"ssl_error","status_checked_at":"2026-03-07T14:02:43.192Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2024-10-12T00:08:06.527Z","updated_at":"2026-03-07T16:31:03.134Z","avatar_url":"https://github.com/jacksu.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ZeppelinHub Documentation\n\n## 1. Install Mkdocs\nZeppelinHub Documentation is made by [Mkdocs](http://www.mkdocs.org/). So you need to [install mkdocs](http://www.mkdocs.org/#installation). In order to install MkDocs, you'll need [Python](https://www.python.org/) installed on your system, as well as the Python package manager, [pip](https://pip.pypa.io/en/stable/). You can check if you have these already installed like so:  MkDocs supports Python 2.6, 2.7, 3.3 and 3.4.\n\n```\n$ python --version\nPython 2.6.x\n$ pip --version\npip 1.5.X\n```\n\nInstall the mkdocs package using pip:\n\n```\n$ pip install mkdocs\n```\n\n## 2. Clone this repository\nJust clone this repository.\n\n## 3. How to add a new documentation page?\nThis is the directory structure of this repository.\n\n```\n    |-- zeppelinhub-documentation\n    |   |-- docs\n    |       |-- CNAME\n    |       |-- css\n    |       |-- js\n    |       |-- img\n    |       |-- favicon.ico\n    |       |-- index.md\n    |       |-- *.md\n    |   |-- custom_theme\n            |-- *.html\n            |-- __init__.py\n            |-- css\n            |-- img\n            |-- js\n            |-- fonts\n            |-- license\n    |   |-- mkdocs.yml\n    |   |-- README.md\n\n```\n\n* `/mkdocs.yml` : All of the configuration properties will be defined in this file.\n* `/docs` : Under this directory, css file, image files for docs and all of the `.md` files are located in this directory.\n* `/docs/CNAME` : Using this file, you can define the domain name: [http://help.zeppelinhub.com](http://help.zeppelinhub.com).\n* `/docs/css/extra.css`, `/docs/js/extra.js` : You can define extra CSS and javascript function in these directory.\n* `/docs/img/*.png` : You can put all of the image file used for documentation files.\n* `/docs/favicon.ico` : This file will make favicon image to the browser tab. \n* `/docs/index.md` : `index.md` file will make [Home Page](http://help.zeppelinhub.com/) of this site. ( Actually, It's a convetion name of Mkdocs. )\n* `/docs/*.md` : All of the markdown(documentation) files will be located.\n* `/custom-theme/` : All of components related with site theme are located in this directory.  \n* `/custom-theme/__init__.py` : This python file helps this directory to be recognized as a part of this package.\n* `/custom-theme/*.html` : All of the html files composing theme components are located.\n* `/custom-theme/css/*.css` : If you want to customize theme, modify `theme-extra.css` file.\n* `/custom-theme/js/*.js` : All of javascript files related with theme actions are located in this directory.\n\nIf you want to add a new file, just locate the new `.md` file under `/docs` and add some information about the docs to the \u003ccode\u003e[mkdocs.yml](https://github.com/NFLabs/zeppelinhub-documentation/blob/master/mkdocs.yml)\u003c/code\u003e. \n\n## 4. Build and deploy the site\n\nMkDocs comes with a built-in webserver that lets you preview your documentation as you work on it. Start the webserver by making sure you are in the same directory as the `mkdocs.yml` config file, and then running the mkdocs serve command:\n\n```\n$ mkdocs serve\nRunning at: http://127.0.0.1:8000/\n```\nThen you can check your change in realtime at [http://127.0.0.1:8000](http://127.0.0.1:8000).\n\nBefore the deployment, build the site for making sure there is no errors. `--clean` option enables to remove any stale files.\n\n```\n$ mkdocs build --clean\n```\n\nAfter then, let's deploy it to ZeppelinHub Documentation site.\n\n```\n$ mkdocs gh-deploy --clean\n```\n\n# Documentation URL\nAfter complete the deploy, you can see the final result.\n[http://help.zeppelinhub.com/](http://help.zeppelinhub.com/) \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjacksu%2Fzeppelinhub-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjacksu%2Fzeppelinhub-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjacksu%2Fzeppelinhub-documentation/lists"}