{"id":13720974,"url":"https://github.com/yuzhangbit/wiki_barebone","last_synced_at":"2025-05-07T13:31:10.074Z","repository":{"id":78904720,"uuid":"69717900","full_name":"yuzhangbit/wiki_barebone","owner":"yuzhangbit","description":"A simple gollum wiki template which is running as a service.","archived":false,"fork":false,"pushed_at":"2018-12-13T07:48:59.000Z","size":1041,"stargazers_count":4,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-04T01:14:05.921Z","etag":null,"topics":["wiki"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"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/yuzhangbit.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,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-10-01T03:45:33.000Z","updated_at":"2022-06-05T17:50:40.000Z","dependencies_parsed_at":"2023-03-23T01:01:42.603Z","dependency_job_id":null,"html_url":"https://github.com/yuzhangbit/wiki_barebone","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/yuzhangbit%2Fwiki_barebone","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuzhangbit%2Fwiki_barebone/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuzhangbit%2Fwiki_barebone/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuzhangbit%2Fwiki_barebone/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yuzhangbit","download_url":"https://codeload.github.com/yuzhangbit/wiki_barebone/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224604636,"owners_count":17339173,"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":["wiki"],"created_at":"2024-08-03T01:01:10.655Z","updated_at":"2024-11-14T10:30:45.476Z","avatar_url":"https://github.com/yuzhangbit.png","language":"Shell","readme":"Description [![Build Status](https://travis-ci.com/yuzhangbit/wiki_barebone.svg?branch=master)](https://travis-ci.com/yuzhangbit/wiki_barebone)\n-----------\n\nWelcome to wiki. This wiki will be hosted automatically in your local machine when you start the ubuntu after the installation. You can edit the content in markdown and preview the page from the browser directly whenever you want.\n\nDependencies\n------------\n\n-\t[rbenv](https://github.com/rbenv/rbenv) (ruby version manager, avoid messing up with the ruby comes with the system)\n-\t[bundler](https://github.com/bundler/bundler) (ruby application gem manager, install and update gems with ease)\n-\t[gollum](https://github.com/gollum/gollum) (wiki engine)\n-\t[supervisor](http://supervisord.org/) (Automatically host the wiki when the system starts, also provide a nice gui to control programs)\n\nInstallation\n------------\n\nRun the install script in the repo. This install script has only been tested on ubuntu 14.04 LTS and 16.04 LTS.\n\n```bash\ngit clone https://github.com/yuzhangbit/wiki_barebone.git\ncd wiki_barebone  \n```\n\nIf it is your first time to install dependencies, please run commands below.\n\n```bash\n./install.sh  # install dependencies, rbenv, bundler, gollum, supervisor, enable the web gui for supervisor\n./setup.sh    # set up the autostart configuration for the wiki app\n```\n\nIf you have already installed the dependencies, make your wiki automatically start using commands below,\n\n```bash\n./setup.sh\n```\n\nUsage\n-----\n\nOpen your browser and check the wiki out.\n\n```bash\nlocalhost:8888\n```\n\n#### Start and Stop wiki\n\nThis wiki will be hosted automatically when you start the ubuntu. You can control the program through commands below or web gui interfaces.\n\n```bash\nsudo supervisorctl start wiki     # start to host the wiki, the \"wiki\" is defined by the APP_NAME variable.\nsudo supervisorctl restart wiki   # restart to host the wiki, the \"wiki\" is defined by the APP_NAME variable.\nsudo supervisorctl stop wiki      # stop to host the wiki,  the \"wiki\" is defined by the APP_NAME variable.\n```\n\n#### Web gui to control the wiki app using the supervisor\n\nOpen your browser and run the command below.\n\n```bash\nlocalhost:9001\n```\n\nYou can see the web gui for the supervisor to control the wiki app program.  \n![gui](images/supervisor_web_gui.png)\n\n#### Preview\n\n![Demo](images/preview.png)\n\n#### Edit Mode View\n\n![Edit](images/edit.png)\n\nAdjustable Parameters\n---------------------\n\nYou can modify the port number of your wiki in **setup.bash**,\n\n```bash\nPORT=\"8888\"    # hosting port\n```\n\nThen run the command:\n\n```bash\n./setup.sh\n```\n\nBelow is your service name of your wiki.\n\n```bash\nAPP_NAME=\"wiki\"   # default value is wiki\n```\n\nThe Gollum Configuration used by this repo:\n-------------------------------------------\n\n```ruby\nGollum::Page.send :remove_const, :FORMAT_NAMES if defined? Gollum::Page::FORMAT_NAMES\nwiki_options = {\n  :live_preview =\u003e true,\n  :allow_uploads =\u003e true,\n  :per_page_uploads =\u003e true,\n  :allow_editing =\u003e true,\n  :css =\u003e true,\n  :js =\u003e true,\n  :mathjax =\u003e true,\n  :h1_title =\u003e true,\n  :emoji =\u003e true\n}\nPrecious::App.set(:wiki_options, wiki_options)\n```\n","funding_links":[],"categories":["Coding \u0026 Documentation"],"sub_categories":["Markdown"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuzhangbit%2Fwiki_barebone","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyuzhangbit%2Fwiki_barebone","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuzhangbit%2Fwiki_barebone/lists"}