{"id":17169446,"url":"https://github.com/johnmurray/docem","last_synced_at":"2025-07-22T01:31:27.077Z","repository":{"id":30996172,"uuid":"34554543","full_name":"JohnMurray/docem","owner":"JohnMurray","description":"A documentation hosting server for static content","archived":false,"fork":false,"pushed_at":"2015-08-23T00:26:44.000Z","size":572,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-24T19:18:25.300Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JohnMurray.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":"2015-04-25T04:02:46.000Z","updated_at":"2015-06-26T15:22:52.000Z","dependencies_parsed_at":"2022-08-26T08:20:21.705Z","dependency_job_id":null,"html_url":"https://github.com/JohnMurray/docem","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/JohnMurray/docem","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnMurray%2Fdocem","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnMurray%2Fdocem/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnMurray%2Fdocem/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnMurray%2Fdocem/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JohnMurray","download_url":"https://codeload.github.com/JohnMurray/docem/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnMurray%2Fdocem/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266409463,"owners_count":23924284,"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","status":"online","status_checked_at":"2025-07-21T11:47:31.412Z","response_time":64,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"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-14T23:26:14.688Z","updated_at":"2025-07-22T01:31:27.022Z","avatar_url":"https://github.com/JohnMurray.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Doc'Em](https://raw.githubusercontent.com/JohnMurray/docem/master/public/images/logo_github.jpg)\n\n[![Build Status](https://travis-ci.org/JohnMurray/docem.svg?branch=master)](https://travis-ci.org/JohnMurray/docem)\n[![Codacy Badge](https://www.codacy.com/project/badge/2d43c7ea33004844b336d367b0d003cd)](https://www.codacy.com/app/me_11/docem)\n[![License](https://img.shields.io/github/license/johnmurray/docem.svg)](https://github.com/JohnMurray/docem/blob/master/LICENSE)\n[![Current Release](https://img.shields.io/github/release/johnmurray/docem.svg)](https://github.com/JohnMurray/docem/releases)\n\nDoc'Em is a documentation hosting service focusing on static content-hosting. It\nhandles per-project versioning and global search across all projects and versions.\n\n__NOTE__ - This project is under pretty heavy development and currently unstable.\n\n\n## Why?\n\nIf you work in any sort of large organization, then you likely have lots of internal\napplications. You may also find the documentation in those projects a bit lacking.\nPart of this is because developers are lazy and the other part is because of lack of\ntooling. This project solves the latter problem. \n\n## Tooling Problems\n\n### Wiki's\nWhen it comes to good documentation, wiki's are a major problem (not a solution). If\nyou're wiki cannot be tied to source-control, branched, and versioned then you likely \ndo not have an adequate system unless you are spending a _major_ amount of time keeping\nit up to date. Good documentation needs to live alongside your code (in the same repo)\nso that changes in the docs happen simultaneously with code-changes. \n\n### Hosting\nIf you decide to do the right thing and _not_ use a wiki, then you're left trying to\nfigure out _where_ to host your docs and in what system to write them in. While there are\nplenty of systems out there, hanlding versioning well within those system can be hit-or-miss.\n\nBack to the where, in large organizations this can mean lots of little web-servers hosting\ndocs spread out everywhere. While this can mean a lot of things, it mostly means that\nyour users will have a hard time remembering where to go for _your_ application's docs\namongst all the others they are already using. This additional mental overhead can\nmean they'll just bug your team with more questions instead of referring to your docs.\n\n\n## Advantages Over Apache + FTP\n\nBeing a server for hosting static content, you may wonder why not just use something like Apache\nor Nginx to serve your static content and use FTP to manage that content on the server. You\ncould very well do this and be perfectly fine. Using this software, however, buys you\nthe following advantages.\n\n### Immutable Versions / Version Locks\n\nTODO: Talk about version locking\n\n### Queryable API\n\nTodo: Talk about Project/Project-Version APIs\n\n### Documentation Search Application\n\nOne thing that you will not get when using plain 'ole Apache and FTP is an application\nto search all available documentation. This application provides that functionality on\nthe landing page showing the project's name, description, available versions, and a \nsearch functionality ot filter what you are looking for. Having all of this certainly\nwins out over scanning through a \"directory view\" in Apache, trying to figure out where\nthe project you are looking for is, or what a given project does.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnmurray%2Fdocem","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohnmurray%2Fdocem","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnmurray%2Fdocem/lists"}