{"id":21681665,"url":"https://github.com/syrup/markdown-it-template","last_synced_at":"2026-04-07T22:31:33.394Z","repository":{"id":59630636,"uuid":"432942202","full_name":"Syrup/markdown-it-template","owner":"Syrup","description":"create blog with markdown using markdown-it","archived":false,"fork":false,"pushed_at":"2025-11-01T03:32:11.000Z","size":2095,"stargazers_count":3,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-01T05:25:26.268Z","etag":null,"topics":["markdown","markdown-it","markdown-it-app","markdown-it-example","markdown-it-template","markdown-to-html","markdown-website","markdownitapp"],"latest_commit_sha":null,"homepage":"https://markdownitapp.mioun.repl.co/","language":"JavaScript","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/Syrup.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["Syrup"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2021-11-29T07:22:20.000Z","updated_at":"2023-01-13T18:22:08.000Z","dependencies_parsed_at":"2024-11-25T15:43:51.784Z","dependency_job_id":null,"html_url":"https://github.com/Syrup/markdown-it-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Syrup/markdown-it-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syrup%2Fmarkdown-it-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syrup%2Fmarkdown-it-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syrup%2Fmarkdown-it-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syrup%2Fmarkdown-it-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Syrup","download_url":"https://codeload.github.com/Syrup/markdown-it-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syrup%2Fmarkdown-it-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31532194,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T16:28:08.000Z","status":"ssl_error","status_checked_at":"2026-04-07T16:28:06.951Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["markdown","markdown-it","markdown-it-app","markdown-it-example","markdown-it-template","markdown-to-html","markdown-website","markdownitapp"],"created_at":"2024-11-25T15:30:26.058Z","updated_at":"2026-04-07T22:31:33.389Z","avatar_url":"https://github.com/Syrup.png","language":"JavaScript","readme":"\u003ca href=\"https://repl.it/github/syrup/markdownitapp\"\u003e\u003cimg src=\"https://img.shields.io/badge/Repl.it-FORK-brightgreen\" /\u003e\u003c/a\u003e\n\n# How to Use\nWell... it's not finished yet but ready to use.\n\nI will show you how to create a new page\n\nopen `views/markdown`\nand create new file with format `.md`.\n\u003e WARNING: do not use special characters when naming files.\n\nOpen a new file and fill it with markdown\n\nExample:\n```md\n---\ntitle: Your Title\n---\n\n# Hello World\n\u003e Blockquote\n[Link]()\n```\n\nNow check by going to the url `http://your-web.com/article/filename`.\n\nYou can also custom css in `public/style.css`.\n\n*Check `config.toml` file for global configuration*\n\n*and `frontmatter` for inpage configuration.*\n\nExample open [https://markdownitapp.mioun.repl.co/example](https://markdownitapp.mioun.repl.co/example).\n\nTo run server use\n```bash \nbash main.sh\n```\n\ninstead of \n\n```bash\nnpm start\n```\n\nif it's the first time.\n\nAnd then, you can add anything you want like navbar :)\n\n## Performance Features\n\nThe application includes several performance optimizations:\n\n- **File Caching**: Markdown files are processed once and cached in memory, resulting in 86-95% faster response times on subsequent requests.\n- **Efficient Minification**: CSS and JS files are minified using synchronous operations for faster build times.\n\n## Dark Mode\n\nThe application now includes a fully functional dark mode feature:\n\n- **Toggle Button**: Click the 🌑/☀️ button in the bottom-right corner to switch between light and dark modes\n- **Persistent Preference**: Your dark mode preference is saved in localStorage and persists across page visits\n- **Dynamic Themes**: Automatically switches highlight.js syntax highlighting theme to match the current mode\n- **Configuration**: Set the default mode in `config.toml` with the `darkmode` option (users can still override this with the toggle)\n\n## CSS Framework Options\n\nChoose between custom CSS or Pico CSS (classless framework):\n\n- Edit `config.toml` and set `css_framework` to:\n  - `\"custom\"` - Use custom styling (default)\n  - `\"pico\"` - Use Pico CSS for automatic semantic HTML styling\n\n## Development Mode\n\nWhen developing and making changes to markdown files, you can disable caching by setting the `CLEAR_CACHE` environment variable:\n\n```bash\nCLEAR_CACHE=true npm start\n```\n\nThis ensures you see file changes immediately without needing to restart the server.\n\n## Static Site Generation\n\nThis project supports static site generation for deployment to serverless platforms like Vercel, Netlify, or GitHub Pages.\n\n### Development\n\n```bash\nnpm install\nnpm run dev    # Start development server\n```\n\n### Build for Production\n\n```bash\nnpm run build  # Generates static site in /dist directory\n```\n\n### Deploy to Vercel\n\n```bash\nnpm install -g vercel\nvercel\n```\n\nOr connect your GitHub repo to Vercel for automatic deployments.\n\n### Deploy to Netlify\n\n```bash\nnpm install -g netlify-cli\nnetlify deploy --prod\n```\n\n### Deploy to GitHub Pages\n\n1. Build the site: `npm run build`\n2. Push `dist` folder to `gh-pages` branch\n3. Enable GitHub Pages in repository settings\n\n### Project Structure\n\n- `/views/markdown/*.md` - Markdown content files\n- `/public/*` - Static assets (CSS, JS, images)\n- `/dist/*` - Built static site (generated)\n\n---\n\nThat's all for now.\n\n\u003cdetails\u003e\n  \u003csummary\u003eFooter\u003c/summary\u003e\n  \u003cdiv class=\"content\"\u003e\n    \n\u003e TODO:\n\u003e  1. [x] Create a routing system\n\u003e  2. [ ] Reach 10★ on Github\n\n\n\u003ca href=\"https://github.com/Syrup/markdownitapp\"\u003eGithub\u003c/a\u003e\n\n\n\u003e CREDITS:\n\u003e 1. [markdown-it](https://github.com/markdown-it/markdown-it)\n\u003e 2. [markdown-it-task-lists](https://github.com/revin/markdown-it-task-lists)\n\u003e 3. [highlight.js](https://github.com/highlightjs/highlight.js/)\n\u003e 4. [front-matter](https://github.com/jxson/front-matter)\n\u003e 5. [handlebars](https://github.com/handlebars-lang/handlebars.js)\n  \u003c/div\u003e\n\u003c/details\u003e","funding_links":["https://github.com/sponsors/Syrup"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyrup%2Fmarkdown-it-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsyrup%2Fmarkdown-it-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyrup%2Fmarkdown-it-template/lists"}