{"id":20521555,"url":"https://github.com/hackmdio/themes","last_synced_at":"2026-03-02T05:31:21.584Z","repository":{"id":58613962,"uuid":"507783764","full_name":"hackmdio/themes","owner":"hackmdio","description":"Official HackMD themes repository","archived":false,"fork":false,"pushed_at":"2022-08-25T07:43:36.000Z","size":553,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-10-20T04:50:30.010Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/hackmdio.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":"2022-06-27T06:07:56.000Z","updated_at":"2023-01-22T10:58:22.000Z","dependencies_parsed_at":"2022-09-22T21:41:00.230Z","dependency_job_id":null,"html_url":"https://github.com/hackmdio/themes","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hackmdio/themes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fthemes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fthemes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fthemes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fthemes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hackmdio","download_url":"https://codeload.github.com/hackmdio/themes/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fthemes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29993376,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-02T01:47:34.672Z","status":"online","status_checked_at":"2026-03-02T02:00:07.342Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","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-11-15T22:29:51.530Z","updated_at":"2026-03-02T05:31:21.557Z","avatar_url":"https://github.com/hackmdio.png","language":"TypeScript","readme":"# HackMD Themes\n\n[Description: TBD]\n\n## Themes\n\n\u003c!-- THEME_START --\u003e\n\n| Theme              | Preview                             | Embed Snippet                  |\n| ------------------ | ----------------------------------- | ------------------------------ |\n| GitBook Book Theme | ![gitbook](docs/images/gitbook.png) | `{% hackmd @themes/gitbook %}` |\n\n\u003c!-- THEME_END --\u003e\n\n## Getting Started with HackMD Themes Development\n\nhttps://user-images.githubusercontent.com/4230968/186604892-f430af0a-c494-43c3-9e87-3ca1a9a901df.mp4\n\n### Prerequisites\n\n- [Register for a HackMD account](https://hackmd.io) and create an API token on [the settings page](https://hackmd.io/settings#api)\n- [Create a test team](https://hackmd.io/c/tutorials/%2F%40docs%2Fwhat-is-team) for theme development, it can either be a private team or a public team.\n\n### Setup\n\nThis project use [`pnpm`](https://pnpm.io/) as package manager. You can install it by:\n\n```bash\nnpm install -g pnpm\n```\n\nThen install dependencies:\n\n```bash\npnpm install\n```\n\n### Fill the credentials\n\nCopy `.env.example` to `.env` and fill the credentials.\n\n```bash\ncp .env.example .env\n```\n\nYour `.env` file should look like this:\n\n```bash\nHACKMD_ACCESS_TOKEN=hackmd-access-token\nHACKMD_WORKSPACE_TEAM_PATH=team-path\n```\n\nWhere `hackmd-access-token` is the API token you created on [the settings page](https://hackmd.io/settings#api), and `team-path` is the path of the team you created for theme development. **Remember to change these values to your own**.\n\n### Build\n\n```bash\npnpm build\n```\n\n### Watch Themes and Build\n\n```bash\npnpm dev\n```\n\n## How to create a new theme\n\n1. Create a folder with the name of your theme in `src` directory, and create `style.scss` in it. For example, if your theme name is `my-theme`, you should create `src/my-theme/style.scss`.\n2. Create a JSON file named `meta.json` in the same folder. The content of `meta.json` should be like this:\n\n   ```json\n   {\n     \"slug\": \"my-theme\",\n     \"name\": \"My HackMD Theme\"\n   }\n   ```\n\n   - `slug` is the permalink of your Theme\n   - `name` is the name of your theme\n\n3. The folder structure might look like this:\n\n   ```bash\n   src\n   └── my-theme\n       ├── meta.json\n       └── style.scss\n   ```\n\n4. Run `pnpm dev` to watch your theme and build it. The CLI will print out a table like this:\n\n   ```bash\n   ┌───────────────────────────┬──────────────┬───────────────────────────────────────────────┬───────────────────────────────────────┐\n   │ title                     │ permalink    │ publishLink                                   │ syntax                                │\n   ├───────────────────────────┼──────────────┼───────────────────────────────────────────────┼───────────────────────────────────────┤\n   │ HackMD Theme - My Theme   │ gitbook-book │ https://hackmd.io/@test-team-dev/my-theme     │ {% hackmd @test-team-dev/my-theme %}  │\n   └───────────────────────────┴──────────────┴───────────────────────────────────────────────┴───────────────────────────────────────┘\n   ```\n\n   - Use the `syntax` to include your theme in HackMD notes and test it.\n\n## Thanks\n\n- Workflow from [@Hsins](https://github.com/@Hsins)'s [hackmd-themes](https://github.com/Hsins/hackmd-themes) for inspiring this project.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackmdio%2Fthemes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhackmdio%2Fthemes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackmdio%2Fthemes/lists"}