{"id":21925691,"url":"https://github.com/jmcfarlane/goremark","last_synced_at":"2026-04-13T21:03:20.332Z","repository":{"id":57612202,"uuid":"47318519","full_name":"jmcfarlane/goremark","owner":"jmcfarlane","description":null,"archived":false,"fork":false,"pushed_at":"2023-04-21T04:52:39.000Z","size":4,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-27T11:15:15.852Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/jmcfarlane.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-12-03T08:28:31.000Z","updated_at":"2023-04-21T04:50:18.000Z","dependencies_parsed_at":"2024-06-20T13:13:26.019Z","dependency_job_id":"baf8017f-8dc1-4279-95c4-e941cb25e703","html_url":"https://github.com/jmcfarlane/goremark","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/jmcfarlane%2Fgoremark","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmcfarlane%2Fgoremark/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmcfarlane%2Fgoremark/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmcfarlane%2Fgoremark/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jmcfarlane","download_url":"https://codeload.github.com/jmcfarlane/goremark/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244951197,"owners_count":20537335,"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-11-28T21:19:42.848Z","updated_at":"2026-04-13T21:03:20.299Z","avatar_url":"https://github.com/jmcfarlane.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Goremark\n\nSimple script to consume a [Remarkjs](http://remarkjs.com/) compliant\nmarkdown file and serve it up as a presentation. This way you can keep\nyour documentation in git, let Github or Gitlab render it, but easily\npresent it as a slide deck when needed.\n\n## Installation\n\n```\ngo get github.com/jmcfarlane/goremark\n```\n\n## Usage\n\n```\ngoremark\n```\n\nThis will serve up `README.md` and assume all static content is inside\nthe `docs` directory.\n\n## Other markdown files\n\n```\ngoremark -f foo.md\n```\n\nThis will make the same assumption about static content as before.\n\n## Other markdown files in subdirectories\n\n```\ngoremark -f docs/design.md -p .\n```\n\nThis time we serve up the design document from **within** the docs\ndirectory. Here we need to pass the `-p` flag to specify the project\ndirectory as the current working directory, else it'll look for the\n`docs` directory inside the `docs` folder.\n\nAny valid path will do. For example the following would be a perfectly\nvalid thing to do:\n\n```\ncd /tmp\ngoremark -f ~/my/repo/docs/best-practices.md -p ~/my/repo\n```\n\n## Static content located elsewhere\n\nThe default static content folder is `docs`. If you happen to keep\nyours in another folder, provide the name via the `-s` flag (without\nany leading slashes):\n\n```\ngoremark -s static\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmcfarlane%2Fgoremark","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjmcfarlane%2Fgoremark","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmcfarlane%2Fgoremark/lists"}