{"id":21623155,"url":"https://github.com/explooosion/gitbook-boilerplate","last_synced_at":"2025-03-18T19:27:50.990Z","repository":{"id":66234052,"uuid":"129639529","full_name":"explooosion/gitbook-boilerplate","owner":"explooosion","description":"Please Fork this repo if you want to start your own book with Gitbook","archived":false,"fork":false,"pushed_at":"2018-04-15T19:34:28.000Z","size":656,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-24T22:11:48.636Z","etag":null,"topics":["boilerplate","demo","example","gitbook"],"latest_commit_sha":null,"homepage":"http://robby570.tw/gitbook-boilerplate/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/explooosion.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":"2018-04-15T18:38:24.000Z","updated_at":"2024-09-07T09:00:12.000Z","dependencies_parsed_at":"2023-02-24T01:00:45.382Z","dependency_job_id":null,"html_url":"https://github.com/explooosion/gitbook-boilerplate","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/explooosion%2Fgitbook-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/explooosion%2Fgitbook-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/explooosion%2Fgitbook-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/explooosion%2Fgitbook-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/explooosion","download_url":"https://codeload.github.com/explooosion/gitbook-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244287926,"owners_count":20428896,"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":["boilerplate","demo","example","gitbook"],"created_at":"2024-11-25T00:11:50.303Z","updated_at":"2025-03-18T19:27:50.933Z","avatar_url":"https://github.com/explooosion.png","language":"HTML","readme":"# Gitbook Boilerplate\n\n[![forthebadge](https://forthebadge.com/images/badges/fuck-it-ship-it.svg)](https://github.com/explooosion/gitbook-boilerplate)\n[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://github.com/explooosion/gitbook-boilerplate)\n[![forthebadge](https://forthebadge.com/images/badges/makes-people-smile.svg)](https://github.com/explooosion/gitbook-boilerplate)\n\n### Online Demo\n\n👉 [Start Reading](http://robby570.tw/gitbook-boilerplate/)\n\n### Global Installation\n\nInstallation is done using the\n[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):\n\n```bash\nnpm install -g gitbook-cli\n```\n\n```bash\ngitbook install\n```\n\n### Run Gitbook\n\n#### View\n\nUsing `dev` to run local [http://192.168.0.100:8080](http://192.168.0.100:8080)\n\n```bash\nnpm run dev\n```\n\nIf you want to watch files, please remove the folder `_book` after running the script `dev`.\n\n\u003e from [git serve can't restart when file changes #1379](https://github.com/GitbookIO/gitbook/issues/1379)    \n\n#### Image\n\nYou can put images to [imgur](https://imgur.com/), please install [vscode-imgur](https://github.com/MaxfieldWalker/vscode-imgur).\n\u003e Add your imgur key to `.vscode` / `settings.json`\n\n\u003e Hotkey `Ctrl` + `Alt` + `V`\n\n### Build To HTML\n\nUsing `build` to compile the files into `docs`.\n\n```bash\nnpm run build\n```\n\n### Convert To PDF\n\nUsing `pdf` to export the PDF format.\n\n```bash\nnpm run pdf\n```\n\u003e If your OS is Windows, please download [Calibre](https://calibre-ebook.com/download_windows).\n\n### Use Disqus\n\nInput your shortname into `book.json`,\nthen you can use the [disqus](https://disqus.com/) plugin.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexplooosion%2Fgitbook-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexplooosion%2Fgitbook-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexplooosion%2Fgitbook-boilerplate/lists"}