{"id":16391957,"url":"https://github.com/mikeshultz/wikionastick","last_synced_at":"2025-06-11T22:37:49.657Z","repository":{"id":147876751,"uuid":"111080913","full_name":"mikeshultz/wikionastick","owner":"mikeshultz","description":"A wiki that runs on, and renders markdown documents from a thumbdrive","archived":false,"fork":false,"pushed_at":"2017-11-19T08:26:14.000Z","size":39,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-03T21:16:45.775Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","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/mikeshultz.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":"2017-11-17T08:53:38.000Z","updated_at":"2017-11-17T09:09:22.000Z","dependencies_parsed_at":"2023-05-27T18:45:45.067Z","dependency_job_id":null,"html_url":"https://github.com/mikeshultz/wikionastick","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikeshultz%2Fwikionastick","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikeshultz%2Fwikionastick/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikeshultz%2Fwikionastick/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikeshultz%2Fwikionastick/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mikeshultz","download_url":"https://codeload.github.com/mikeshultz/wikionastick/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240245909,"owners_count":19771028,"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":[],"created_at":"2024-10-11T04:48:01.089Z","updated_at":"2025-02-22T22:27:46.763Z","avatar_url":"https://github.com/mikeshultz.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Wiki On A Stick\n\n[![Build Status](https://travis-ci.org/mikeshultz/wikionastick.svg?branch=master)](https://travis-ci.org/mikeshultz/wikionastick)\n\nA wiki that runs on, and renders markdown documents from a thumbdrive.\n\n![Screenshot](https://i.imgur.com/hJwDVw4.png)\n\n## Install\n\n### Automagic Install\n\n    WOS_INSTALL_PATH=/mnt/thumb-drive bash \u003c(curl -s https://raw.githubusercontent.com/mikeshultz/wikionastick/master/install_usb.sh)\n\nYou can review [the installer script](https://github.com/mikeshultz/wikionastick/blob/master/install_usb.sh)\nahead of time, but this is the easiest way to install WikiOnAStick to a **mounted**\nthumbdrive.\n\nIf you only need a specific OS supported, set `WOS_OS` to one of the following:\n`linux64`, `darwin64`, `freebsd64` or `win64`.\n\n### Manual\n1) Grab a copy of the release from the [releases](https://github.com/mikeshultz/wikionastick/releases)\npage.\n2) Create a directory on your thumbdrive that will contain your docs\n3) Unzip/untar files to that directory\n4) Create documentation files, with `index.md` or `README.md` as the default \npage.  All links are relative.\n\nSee the Example below for more information.\n\n## Usage\n\n\tUsage:\n\t  wikionastick [OPTIONS]\n\n\tApplication Options:\n\t  -t, --template= Path to a template directory\n\t  -l, --loglevel= Log level. ['debug', 'info', 'warning', 'error']\n\n\tHelp Options:\n\t  -h, --help      Show this help message\n\n## Templates\n\nYou can create your own HTML/CSS/JS templates. Just copy the directory \n`templates/default` to `templates/mytemplate` and modify files as necessary.  \nYou will have to invoke `wikionastick` with the new template path:\n\n    wikionastick -t templates/mytemplate\n\n## Example\n\nThumbdrive layout:\n\n    /mnt/thumbdrive\n        wikionastick\n        templates/\n            default/\n                base_template.html\n                main.css\n        README.md\n        docs/\n            example.md\n\nREADME.md:\n\n    # Hello!\n\n    World.  See my [example notes](docs/example.md).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikeshultz%2Fwikionastick","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikeshultz%2Fwikionastick","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikeshultz%2Fwikionastick/lists"}