{"id":20441390,"url":"https://github.com/sandromaglione/menimal","last_synced_at":"2025-08-04T05:33:07.838Z","repository":{"id":220457579,"uuid":"751689592","full_name":"SandroMaglione/menimal","owner":"SandroMaglione","description":"Generate a static html-only website from markdown and css・No javascript, no package.json, focus on content 🤏","archived":false,"fork":false,"pushed_at":"2024-02-15T11:41:43.000Z","size":290,"stargazers_count":13,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-20T05:52:30.705Z","etag":null,"topics":["effect","effect-ts","static-site","static-site-generation","static-site-generator"],"latest_commit_sha":null,"homepage":"https://www.sandromaglione.com/newsletter","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/SandroMaglione.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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":"2024-02-02T05:33:07.000Z","updated_at":"2025-01-19T11:31:03.000Z","dependencies_parsed_at":"2024-02-15T12:46:38.983Z","dependency_job_id":null,"html_url":"https://github.com/SandroMaglione/menimal","commit_stats":null,"previous_names":["sandromaglione/effect-static-site-generation","sandromaglione/menimal"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/SandroMaglione/menimal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SandroMaglione%2Fmenimal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SandroMaglione%2Fmenimal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SandroMaglione%2Fmenimal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SandroMaglione%2Fmenimal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SandroMaglione","download_url":"https://codeload.github.com/SandroMaglione/menimal/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SandroMaglione%2Fmenimal/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268654340,"owners_count":24285122,"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-08-04T02:00:09.867Z","response_time":79,"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":["effect","effect-ts","static-site","static-site-generation","static-site-generator"],"created_at":"2024-11-15T09:32:33.811Z","updated_at":"2025-08-04T05:33:07.703Z","avatar_url":"https://github.com/SandroMaglione.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1\u003eMenimal 🤏\u003c/h1\u003e\n\u003cp\u003e\n  \u003ca href=\"https://github.com/SandroMaglione\"\u003e\n    \u003cimg alt=\"GitHub: SandroMaglione\" src=\"https://img.shields.io/github/followers/SandroMaglione?label=Follow\u0026style=social\" target=\"_blank\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://twitter.com/SandroMaglione\"\u003e\n    \u003cimg alt=\"Twitter: SandroMaglione\" src=\"https://img.shields.io/twitter/follow/SandroMaglione.svg?style=social\" target=\"_blank\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n`Menimal` is a minimal **static site generator**.\n\n\u003e Focus on content: **just write markdown files, css styles, and everything else is generated for you** \n\n![Menimal folder structure](/docs/menimal-folder-structure.png \"Folder structure\")\n\n`Menimal` is minimal by design:\n- No javascript (no `package.json`)\n- No HTML templates\n- No mdx\n- No SEO or metadata\n\n***\n\n- [Getting started](#getting-started)\n  - [Deploy](#deploy)\n- [Folder structure](#folder-structure)\n  - [`pages`](#pages)\n  - [`static`](#static)\n  - [`config.json`](#configjson)\n  - [`style.css`](#stylecss)\n- [Roadmap](#roadmap)\n- [License](#license)\n- [Notes](#notes)\n  - [Other static site generators](#other-static-site-generators)\n  - [Development](#development)\n  - [Implementation](#implementation)\n\n## Getting started\n`Menimal` is a single `npx` script that you can run from everywhere without installing any package.\n\n\u003e 👉 Make sure you have [NodeJs](https://nodejs.org/en) installed on your machine\n\nYou just need to run a single command:\n\n```shell\nnpx menimal\n```\n\nThis will generate a `build` folder containing your static website.\n\n### Deploy\nHosting platforms allow to define a build command and an output folder:\n- Build command: `npx menimal`\n- Output folder: `build`\n\n\n![Deploy config](/docs/deploy-config.png \"Deploy config\")\n\n![Menimal build folder](/docs/menimal-build-folder.png \"Build folder\")\n\nThat's all. You can deploy `Menimal` everywhere 🤝\n\n***\n\n## Folder structure\n`Menimal` requires a precise folder structure:\n- **`pages`**: contains markdown files (`.md`)\n- **`static`**: contains static files (`robots.txt`, `fonts`, `favicon.ico`)\n- **`config.json`**: contains site configuration (minimal)\n- **`style.css`**: contains styles (single css file)\n\n\u003e See complete and working example inside [example folder](./example/)\n\n### [`pages`](/example/pages/)\nEvery markdown file will correspond to an `.html` page in the website.\n\nThe name of the file `.md` is used to generate both the name of the HTML file and the title of the page:\n- HTML file: same as `.md` with all lowercase characters\n- Title: same as `.md` with `-` replaced by spaces\n\nFor example, `This-is-the-Title-of-the-article.md` will generate:\n- HTML: `this-is-the-title-of-the-article.html`\n- Title: This is the Title of the article\n\n### [`static`](/example/static/)\nAll the files inside `static` will be copied in the final build.\n\nHere you can add images, fonts, `robots.txt`, `favicon.ico`, `sitemap.xml`, or anything really 💁🏼‍♂️\n\n### [`config.json`](/example/config.json)\nFor now config requires a single field: the name of the website displayed in `\u003cheader\u003e`:\n\n```json\n{\n  \"name\": \"Sandro Maglione\"\n}\n```\n\n### [`style.css`](/example/style.css)\nAll the styles are defined **in a single css file**.\n\n\u003e You can view the generated HTML structure of each file inside [templates](/src/templates/)\n\nThis file will be minified and imported in every generated page.\n\n## Roadmap\n- Preload fonts in HTML\n```html\n\u003clink rel=\"preload\" href=\"font.woff2\" as=\"font\" crossorigin type=\"font/woff2\"\u003e\n```\n## License\n\nMIT License, see the [LICENSE.md](/LICENSE) file for details.\n\n***\n\n## Notes\n\nThis project is part of my weekly newsletter at [**sandromaglione.com**](https://www.sandromaglione.com/newsletter?ref=Github\u0026utm_medium=newsletter_project\u0026utm_term=effect).\n\n\n\u003ca href=\"https://www.sandromaglione.com/newsletter?ref=Github\u0026utm_medium=newsletter_project\u0026utm_term=effect\"\u003e\n    \u003cimg alt=\"sandromaglione.com Newsletter weekly project\" src=\"https://www.sandromaglione.com/static/images/newsletter_banner.webp\" target=\"_blank\" /\u003e \n\u003c/a\u003e\n\n\n### Other static site generators\n- [Hexo](https://hexo.io/)\n- [Jekyll](https://jekyllrb.com/)\n- [Hugo](https://gohugo.io/)\n\n### Development\n- Use `npx --loglevel silly ..` from `example` folder to debug `npx` command\n\n### Implementation\n\n**Read all the details of the implementation in the full article** 👇\n\n\u003ca href=\"https://www.sandromaglione.com/articles/build-and-publish-an-npx-command-to-npm-with-typescript?ref=Github\u0026utm_medium=newsletter_project\u0026utm_term=effect\"\u003e\n    \u003cimg alt=\"Read the full article on my website\" src=\"https://www.sandromaglione.com/api/image?title=Build%20and%20publish%20an%20npx%20command%20to%20npm%20with%20Typescript\u0026publishedAt=2024-02-07\" target=\"_blank\" /\u003e \n\u003c/a\u003e\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsandromaglione%2Fmenimal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsandromaglione%2Fmenimal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsandromaglione%2Fmenimal/lists"}