{"id":15511666,"url":"https://github.com/forestryio/create-static-site","last_synced_at":"2025-08-21T15:31:42.351Z","repository":{"id":57370113,"uuid":"120679048","full_name":"forestryio/create-static-site","owner":"forestryio","description":"Create static websites with no build configuration.","archived":false,"fork":false,"pushed_at":"2018-06-06T11:45:50.000Z","size":1201,"stargazers_count":136,"open_issues_count":24,"forks_count":10,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-10-11T21:43:52.450Z","etag":null,"topics":["hugo","jekyll","static-site"],"latest_commit_sha":null,"homepage":"","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/forestryio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-02-07T22:20:25.000Z","updated_at":"2024-09-02T00:03:23.000Z","dependencies_parsed_at":"2022-09-26T16:41:07.141Z","dependency_job_id":null,"html_url":"https://github.com/forestryio/create-static-site","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forestryio%2Fcreate-static-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forestryio%2Fcreate-static-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forestryio%2Fcreate-static-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forestryio%2Fcreate-static-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/forestryio","download_url":"https://codeload.github.com/forestryio/create-static-site/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229982516,"owners_count":18154575,"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":["hugo","jekyll","static-site"],"created_at":"2024-10-02T09:53:10.252Z","updated_at":"2024-12-20T01:14:55.507Z","avatar_url":"https://github.com/forestryio.png","language":"JavaScript","readme":"[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)\n[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors)\n\n# Create Static Site\n\nCreate static websites with no build configuration.\n\n## Overview\n```\nnpx create-static-site my-site --template hugo\ncd my-site\nnpm start\n```\n\n*([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher)*\n\nThen open [http://localhost:3000/](http://localhost:3000/) to see your app.\u003cbr\u003e\n\n## Creating a Static Site\n\n**You’ll need to have Node \u003e= 6 on your local development machine**. You can use [nvm](https://github.com/creationix/nvm#installation) (macOS/Linux) or [nvm-windows](https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows) to easily switch Node versions between different projects.\n\nTo create a new app, run:\n\n```sh\nnpx create-static-site my-site --template [template]\n```\n\nReplace `[template]` with either `hugo` or `jekyll`.\n\nIt will create a directory called `my-site` inside the current folder.\u003cbr\u003e\nInside that directory, it will generate the initial project structure and install the transitive dependencies:\n\n```\nmy-site\n├── LICENSE\n├── node_modules\n├── package.json\n├── README.md\n├── static-scripts.config.js\n├── .browserslistrc\n├── .eslintrc.yml\n├── .gitignore\n├── .postcssrc.js\n├── .stylelintrc.yml\n├── site/ # Depends on the static site generator\n└── src/\n    ├── css/\n    │   ├── styles.css\n    │   └── imports\n    │       └── resets.css\n    ├── img/\n    │   └── svg/\n    │       ├── bitbucket.svg\n    │       ├── github.svg\n    │       └── gitlab.svg\n    └── js/\n        ├── scripts.js\n        └── imports/\n            └── index.js\n```\n\nNo configuration or complicated folder structures, just the files you need to build your site.\u003cbr\u003e\nOnce the installation is done, you can open your project folder:\n\n```sh\ncd my-site\n```\n\nInside the newly created project, you can run some built-in commands:\n\n### `npm start` or `yarn start`\n\n_Jekyll users will need to run `bundle install` first_\n\nRuns the app in development mode.\u003cbr\u003e\nOpen [http://localhost:3000](http://localhost:3000) to view it in the browser.\n\nThe page will automatically reload if you make changes to the code.\u003cbr\u003e\n\n### `npm build` or `yarn build`\n\nBuilds the site for production to the `dist` folder.\u003cbr\u003e\n\n## Philosophy\n\n* **One Dependency:** There is just one build dependency. It uses Webpack, Babel, ESLint, PostCSS, and other amazing projects, but provides a cohesive curated experience on top of them.\n\n* **No Configuration Required:** You don't need to configure anything. Reasonably good configuration of both development and production builds is handled for you so you can focus on writing code.\n\n* **No Lock-In:** You can “eject” to a custom setup at any time. Run a single command, and all the configuration and build dependencies will be moved directly into your project, so you can pick up right where you left off.\n\n## What's Included?\n\nYour environment will have everything you need to build a modern static website:\n* A Static Site Generator (Jekyll or Hugo)\n* Language extras beyond ES6, like object spread operator.\n* Autoprefixed CSS\n* Hassle-free updates for the above tools with a single dependency.\n\nThe tradeoff is that **these tools are preconfigured to work in a specific way**. If your project needs more customization, you can \"eject\" and customize it, but then you will need to maintain this configuration.\n\n## Static Sites\n\nStatic sites are websites built using static, unchanging files. Because the content is static, delivering it to users requires no server processing time. This feature makes static sites incredibly fast and performant.\n\nStatic site generators are the modern way of building static sites. They convert simple, text-based content files in static files ready for the web.\n\nThey’re fantastic for developers because they are extremely fast, are built to work with version-control, and require little-to-no setup compared to existing monolithic CMS solutions like Wordpress.\n\nCurrently, `create-static-site` supports two static site generators:\n\n- [**Jekyll**](https://jekyllrb.com) is the static site generator written in Ruby and created by [GitHub](https://github.com) founder, Tom Preston Werner.\n- [**Hugo**](https://gohugo.io) is the static site generator written in GoLang and created by Steve Francia.\n\n## Contributing\n\nWe'd love to have your helping hand on `create-static-site`! See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started.\n\n## Contributors\n\nThanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore --\u003e\n| [\u003cimg src=\"https://avatars2.githubusercontent.com/u/6855186?v=4\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003echrisdmacrae\u003c/b\u003e\u003c/sub\u003e](https://github.com/chrisdmacrae)\u003cbr /\u003e[💬](#question-chrisdmacrae \"Answering Questions\") [💻](https://github.com/forestryio/create-static-site/commits?author=chrisdmacrae \"Code\") [🎨](#design-chrisdmacrae \"Design\") [📖](https://github.com/forestryio/create-static-site/commits?author=chrisdmacrae \"Documentation\") [💡](#example-chrisdmacrae \"Examples\") [🤔](#ideas-chrisdmacrae \"Ideas, Planning, \u0026 Feedback\") [👀](#review-chrisdmacrae \"Reviewed Pull Requests\") [📢](#talk-chrisdmacrae \"Talks\") [🔧](#tool-chrisdmacrae \"Tools\") [✅](#tutorial-chrisdmacrae \"Tutorials\") | [\u003cimg src=\"https://avatars2.githubusercontent.com/u/824015?v=4\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003encphillips\u003c/b\u003e\u003c/sub\u003e](https://github.com/ncphillips)\u003cbr /\u003e[💬](#question-ncphillips \"Answering Questions\") [🐛](https://github.com/forestryio/create-static-site/issues?q=author%3Ancphillips \"Bug reports\") [💻](https://github.com/forestryio/create-static-site/commits?author=ncphillips \"Code\") [📖](https://github.com/forestryio/create-static-site/commits?author=ncphillips \"Documentation\") [💡](#example-ncphillips \"Examples\") [🤔](#ideas-ncphillips \"Ideas, Planning, \u0026 Feedback\") [🚇](#infra-ncphillips \"Infrastructure (Hosting, Build-Tools, etc)\") [👀](#review-ncphillips \"Reviewed Pull Requests\") [📢](#talk-ncphillips \"Talks\") [⚠️](https://github.com/forestryio/create-static-site/commits?author=ncphillips \"Tests\") [🔧](#tool-ncphillips \"Tools\") | [\u003cimg src=\"https://avatars0.githubusercontent.com/u/6154767?v=4\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eBryan Klein\u003c/b\u003e\u003c/sub\u003e](http://bryanklein.com)\u003cbr /\u003e[🐛](https://github.com/forestryio/create-static-site/issues?q=author%3Azivbk1 \"Bug reports\") [📖](https://github.com/forestryio/create-static-site/commits?author=zivbk1 \"Documentation\") [🤔](#ideas-zivbk1 \"Ideas, Planning, \u0026 Feedback\") | [\u003cimg src=\"https://avatars0.githubusercontent.com/u/776019?v=4\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eScott Gallant\u003c/b\u003e\u003c/sub\u003e](http://forestry.io)\u003cbr /\u003e[🐛](https://github.com/forestryio/create-static-site/issues?q=author%3Ascottgallant \"Bug reports\") [📖](https://github.com/forestryio/create-static-site/commits?author=scottgallant \"Documentation\") [🤔](#ideas-scottgallant \"Ideas, Planning, \u0026 Feedback\") | [\u003cimg src=\"https://avatars2.githubusercontent.com/u/15221702?v=4\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eDJ\u003c/b\u003e\u003c/sub\u003e](https://github.com/dwalkr)\u003cbr /\u003e[💻](https://github.com/forestryio/create-static-site/commits?author=dwalkr \"Code\") [🐛](https://github.com/forestryio/create-static-site/issues?q=author%3Adwalkr \"Bug reports\") [📝](#blog-dwalkr \"Blogposts\") | [\u003cimg src=\"https://avatars3.githubusercontent.com/u/21285108?v=4\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eSebastian Engels\u003c/b\u003e\u003c/sub\u003e](https://github.com/Germoe)\u003cbr /\u003e[🐛](https://github.com/forestryio/create-static-site/issues?q=author%3AGermoe \"Bug reports\") [🤔](#ideas-Germoe \"Ideas, Planning, \u0026 Feedback\") [💻](https://github.com/forestryio/create-static-site/commits?author=Germoe \"Code\") [📖](https://github.com/forestryio/create-static-site/commits?author=Germoe \"Documentation\") | [\u003cimg src=\"https://avatars0.githubusercontent.com/u/1533205?v=4\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eAdam\u003c/b\u003e\u003c/sub\u003e](https://github.com/Koslun)\u003cbr /\u003e[🐛](https://github.com/forestryio/create-static-site/issues?q=author%3AKoslun \"Bug reports\") |\n| :---: | :---: | :---: | :---: | :---: | :---: | :---: |\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!\n\n## Acknowledgements\n\nThis project is greatly inspired by the wonderful [create-react-app](https://github.com/facebookincubator/create-react-app/) project.\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fforestryio%2Fcreate-static-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fforestryio%2Fcreate-static-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fforestryio%2Fcreate-static-site/lists"}