{"id":15659583,"url":"https://github.com/ijjk/mykb","last_synced_at":"2025-10-27T18:09:29.045Z","repository":{"id":37724609,"uuid":"133761414","full_name":"ijjk/mykb","owner":"ijjk","description":"A file system/markdown based knowledge base editor/viewer","archived":false,"fork":false,"pushed_at":"2022-12-22T08:56:11.000Z","size":2626,"stargazers_count":23,"open_issues_count":20,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-30T23:11:06.330Z","etag":null,"topics":["knowledgebase","markdown","nextjs","react","react-hooks"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/ijjk.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}},"created_at":"2018-05-17T05:05:53.000Z","updated_at":"2025-02-25T04:53:30.000Z","dependencies_parsed_at":"2023-01-30T06:30:50.384Z","dependency_job_id":null,"html_url":"https://github.com/ijjk/mykb","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/ijjk%2Fmykb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ijjk%2Fmykb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ijjk%2Fmykb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ijjk%2Fmykb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ijjk","download_url":"https://codeload.github.com/ijjk/mykb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252563870,"owners_count":21768535,"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":["knowledgebase","markdown","nextjs","react","react-hooks"],"created_at":"2024-10-03T13:17:39.179Z","updated_at":"2025-10-27T18:09:28.985Z","avatar_url":"https://github.com/ijjk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MYKB\n\n\u003e A file system/markdown based knowledge base editor/viewer \n\n## Demo\n\nYou can try the demo at: https://mykb.jjsweb.site\n\n\\- Login  \nemail: admin  \npassword: secretpass\n\nP.S. the demo is reset every 10 minutes\n\n## About\n\nMYKB is a file system/markdown based knowledge base editor/viewer built with [Next.js](https://github.com/zeit/next.js)\n\nCurrent features:\n\n- live preview when editing a doc\n- live file system watching\n- caching of docs to speed up searching/viewing of docs\n- offline viewing of cached docs (requires browser that supports service workers)\n- automatic git versioning\n- automatic trusting of Cloudflare reverse proxies\n\n## Installing \n\n- With Docker\n    ```\n    docker run --name mykb -v /path/to/docs:/kb -v /path/to/config:/config --env \"PUID=USER_ID\" --env \"PGID=GROUP_ID\" -p 3000:3000 ijjk/mykb:latest\n    ```\n\n- With yarn (or npm)\n\n    1. Clone repo\n        ```\n        git clone https://github.com/ijjk/mykb\n        ```\n    2. Install dependencies\n        ```\n        cd path/to/mykb; yarn\n        ```\n    3. Build it\n        ```\n        yarn build \u0026\u0026 NODE_ENV=production node ./bin/genSecret.js\n        ```\n    4. Start it\n        ```\n        yarn start\n        ```\n\n## Options\n\nproduction.json (overrides default.json with production NODE_ENV var) \n\n| Name | Description |\n| ---- | ----------- |\n| useGit | Whether or not to use a git repo to automatically version changes to docs (requires git to be installed) |\n| docsDir | The directory where the markdown docs are located |\n| cacheSize | Max size of docs to store in memory for faster searching (default 10MB) |\n| trustCloudflare | Whether to trust X-Forwarded-For header from Cloudflare IPs (used for rate limiting) |\n\ntrustIPs.json - An array of [proxy-addr](https://www.npmjs.com/package/proxy-addr) compatible addresses to trust the X-Forwarded-For header from (Only needed if behind reverse proxy)\n\n## License\n\nCopyright (c) 2017\n\nLicensed under the [MIT license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fijjk%2Fmykb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fijjk%2Fmykb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fijjk%2Fmykb/lists"}