{"id":15395589,"url":"https://github.com/platane/january","last_synced_at":"2026-04-28T20:33:15.236Z","repository":{"id":149248411,"uuid":"90271816","full_name":"Platane/january","owner":"Platane","description":"Static blog generator","archived":false,"fork":false,"pushed_at":"2017-09-09T12:58:04.000Z","size":19372,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-02T02:11:11.390Z","etag":null,"topics":["b","blog","page-transitions","react","single-page-applications","static-site"],"latest_commit_sha":null,"homepage":"https://platane.github.io/january","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/Platane.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2017-05-04T14:17:47.000Z","updated_at":"2018-05-22T12:29:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"dcb7aa34-c663-41db-bb41-93540a28b942","html_url":"https://github.com/Platane/january","commit_stats":{"total_commits":137,"total_committers":1,"mean_commits":137.0,"dds":0.0,"last_synced_commit":"1e7964aabf141dba77a31cc0a06a0c9131018b00"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Platane%2Fjanuary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Platane%2Fjanuary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Platane%2Fjanuary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Platane%2Fjanuary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Platane","download_url":"https://codeload.github.com/Platane/january/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245944062,"owners_count":20697948,"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":["b","blog","page-transitions","react","single-page-applications","static-site"],"created_at":"2024-10-01T15:28:51.924Z","updated_at":"2026-04-28T20:33:15.196Z","avatar_url":"https://github.com/Platane.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Travis](https://img.shields.io/travis/Platane/january.svg?style=flat-square)](https://travis-ci.org/Platane/january)\n\nStatic blog generator.\n\n# features\n\n- 🍰 as simple as git push\n- 🖋 read content as markdown. \n- 📦 generate optimized images resolutions.\n- 🔌 progressive web app, works offline.\n- 👓 rss feed.\n- 🛰 SEO friendly with server side rendering.\n\nalong with neat ui 👍\n\n# build\n\n## Dev\n\nThe app can be served trought webpack-dev-server for developpement purpose. Still, you need at least to build the posts as json and the images.\n\n`yarn run build:contentData \u0026\u0026 yarn run build:images \u0026\u0026 yarn run start`\n\n## Production\n\nThe build process is composed of several steps:\n\n- __yarn run build:contentData__ \nparse the files in `src/content/posts`, write the parsed posts as `dist/posts.jon`\n\n- __yarn run build:asset__ run webpack to build the static assets.\n\n- __yarn run build:images__ parse the `dist/posts.jon` file, generating several versions of images for several dimensions. rewrites the `dist/post.json` to include path to generated images.\n\n- __yarn run build:icons__ generates severals version of the favicon, make them readable in `dist/icons.json`\n__/!\\ this step require to have graphicMagic in path__\n\n- __yarn run build:pages__ pre-render the html pages, reading the `post.json` file.\n\n- __yarn run build:manifest__ build the manifest file, reading the generated icons.\n\n- __yarn run build:serviceWorker__ build the serviceWorker file, reading the assets generated by webpack.\n\n- __yarn run build:rss__ build the rss page.\n\n## path\n\nAs the router later the route, requiring relative path will fail.\n\nIn order to re-write path absolutely, the `ROOT_URL` can be defined and will be append at the start of the paths.\n\nFor example as this project is hosted at `platane.github.io/january`, the style url must be `//platane.github.io/january/asset/style.css`. The base path to set is `//platane.github.io/january`.\n\n## CI\n\nThe `.travis` file allows to build at every push and deploy to gh-pages.\n\n`GITHUB_TOKEN` env var must be set. As well as `BASE_PATH` if applyable.\n\n\n## tl;dr\n\n`yarn run build` to build the static files.\n\n__/!\\ graphicMagic must be installed__\n\nBut you probably shouldn't care as every thing runs on CI 😃.\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplatane%2Fjanuary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplatane%2Fjanuary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplatane%2Fjanuary/lists"}