{"id":19066006,"url":"https://github.com/metapages/metaframe-markdown","last_synced_at":"2025-04-28T12:24:19.626Z","repository":{"id":50532801,"uuid":"390590301","full_name":"metapages/metaframe-markdown","owner":"metapages","description":"Display markdown from input pipes or URL parameters","archived":false,"fork":false,"pushed_at":"2025-02-06T03:03:08.000Z","size":8747,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-18T15:17:38.271Z","etag":null,"topics":["markdown","metaframe"],"latest_commit_sha":null,"homepage":"https://markdown.mtfm.io","language":"TypeScript","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/metapages.png","metadata":{"files":{"readme":"README-developer.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,"zenodo":null}},"created_at":"2021-07-29T03:36:30.000Z","updated_at":"2025-02-06T03:02:06.000Z","dependencies_parsed_at":"2023-12-06T01:27:06.804Z","dependency_job_id":"fe26c57c-568b-4c7b-bfe5-f33357f10ae7","html_url":"https://github.com/metapages/metaframe-markdown","commit_stats":null,"previous_names":[],"tags_count":49,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metapages%2Fmetaframe-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metapages%2Fmetaframe-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metapages%2Fmetaframe-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metapages%2Fmetaframe-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/metapages","download_url":"https://codeload.github.com/metapages/metaframe-markdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251312052,"owners_count":21569156,"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":["markdown","metaframe"],"created_at":"2024-11-09T00:53:59.131Z","updated_at":"2025-04-28T12:24:19.607Z","avatar_url":"https://github.com/metapages.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [Metaframe](https://metapages.org/) template\n\nFast creation and deployment of advanced [metaframe](https://metapages.org/) websites.\n\nTarget audience: developers building [metaframes](https://metapages.org/) or any static website where having the core tools of development, building and publishing are packaged and require a small number of commands.\n\nIt has everything you need to get a connectable [metaframe](https://metapages.org/) website up and running and deployed.\n\n## Fork and modify\n\n1) Fork OR Create new repository\n   - Fork\n   - Create new repository\n      1) Clone the new repository and go there in the terminal\n      2) `git remote add upstream git@github.com:metapages/metaframe-markdown.git`\n      3) `git fetch upstream`\n      4) `git checkout -b upstream upstream/main`\n      5) `git branch -d main`\n      6) `git checkout -b main`\n      7) `git push -u origin main`\n2) Change in `package.json`:\n   - `name` to your npm module name\n     - This repo keeps the npm module name in `package.json` close to the github repo name:\n       - npm: `@metapages/metaframe-...?`\n       - git: `metapages/metaframe-...?`\n   - `repository.url`\n   - `homepage`\n   - `version`: set this to e.g. `0.1.0` or whatever you need\n3) Change in `index.html`: `\u003ctitle\u003e ... \u003c/title\u003e`\n4) Meet [host requirements](#host-requirements)\n5) Maybe change `APP_FQDN` and `APP_PORT` in `.env` (create if needed) to avoid origin collisions\n6) Type `just` and go from there\n\n**Getting upstream improvements:**\n\n1) `git checkout upstream`\n2) `git pull`\n3) `git checkout main`\n4) `git merge upstream`\n\nYou'll have to manually fix the differences where they conflict (they will).\n\n## Host requirements\n\n  - [just](https://github.com/casey/just)\n  - [docker](https://docs.docker.com/get-started/)\n  - [deno](https://deno.land/manual/getting_started/installation)\n  - [mkcert](https://github.com/FiloSottile/mkcert#installation)\n\nThat's it. Commands are self-documenting: just type `just`\n\n## Features\n\n   - automatic https certificate generation\n   - single command development (`just dev`)\n   - single command publishing to [npm](https://www.npmjs.com/)\n   - single command publishing to [github pages](https://pages.github.com/)\n   - `vite` for fast building\n   - `preact` for efficient, fast loading sites\n   - `typescript` for type checking\n   - `chakra-ui.com` for the UI framework\n   - `just` for a single method to build/test/deploy/publish\n   - `docker` because I don't want to touch/rely your host system except where needed\n   - [Github Pages](https://pages.github.com/) publishing\n     - automatic versioning:\n       - `/`: latest\n       - `/v1.5.2/`: that version tag (so all published versions are available forever)\n   - [npm](https://www.npmjs.com/) module publishing\n     - automatic versioning, linked with above\n     - external package versioned with the publised website\n   - Common UI elements\n     - Help button showing the (rendered) local `./Readme.md` file\n     - Options (configurable) stored encoded in the URL hash params\n   - Metaframe outputs updated below, when connected.\n   - `just`file powered, dockerized, automated with dual human/CI controls\n\n\n## Assumptions:\n\n - `just` will be the command runner, not `npm` (directly) or `make` or any other underlying tech specific command runner. `just` is the main entry point to control all aspects of the software lifecycle.\n   - Prefer contextual error messages with calls to action over documentation that is not as close as possible to the code or commands. Distance creates indirection and staleness and barriers to keep updated.\n - You are building to publish at github pages with the url: `https://\u003cuser_org\u003e.github.io/\u003crepo-name\u003e/`\n   - github pages 👆 comes with limited options for some config:\n     - we build browser assets in `./docs` instead of `./dist` (typical default) so that publishing to github pages is less configuration\n - Operating this repository should be \"easy\" and enjoyable. It's a product of love and passion, I am hoping that you enjoy using at least just a little bit.\n\n## Steps:\n\n  1. Fork this repo\n  2. Clone locally\n  3. Modify `package.json` fields to match your own repository e.g. change the module name\n  4. `just dev`\n       - Modify code and publish:\n       - `just publish`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetapages%2Fmetaframe-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmetapages%2Fmetaframe-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetapages%2Fmetaframe-markdown/lists"}