{"id":13486853,"url":"https://github.com/zce/x-pages","last_synced_at":"2025-03-16T17:36:01.373Z","repository":{"id":23604052,"uuid":"99331636","full_name":"zce/x-pages","owner":"zce","description":"A simple static pages development workflow (static site generator maybe)","archived":false,"fork":false,"pushed_at":"2023-11-21T05:24:30.000Z","size":1292,"stargazers_count":47,"open_issues_count":14,"forks_count":26,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-12T08:49:29.746Z","etag":null,"topics":["pages"],"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/zce.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},"funding":{"github":"zce"}},"created_at":"2017-08-04T10:17:25.000Z","updated_at":"2023-08-12T00:13:14.000Z","dependencies_parsed_at":"2024-01-13T19:25:27.767Z","dependency_job_id":"6a9c240c-f189-4546-9140-aeaacae124ac","html_url":"https://github.com/zce/x-pages","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zce%2Fx-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zce%2Fx-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zce%2Fx-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zce%2Fx-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zce","download_url":"https://codeload.github.com/zce/x-pages/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221666419,"owners_count":16860415,"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":["pages"],"created_at":"2024-07-31T18:00:52.118Z","updated_at":"2024-10-27T11:01:36.151Z","avatar_url":"https://github.com/zce.png","language":"JavaScript","funding_links":["https://github.com/sponsors/zce"],"categories":["Related","JavaScript","others"],"sub_categories":["Available Scripts"],"readme":"# x-pages\n\n[![Build Status][travis-image]][travis-url] [![NPM Downloads][downloads-image]][downloads-url] [![NPM Version][version-image]][version-url] [![License][license-image]][license-url] [![Dependency Status][dependency-image]][dependency-url] [![devDependency Status][devdependency-image]][devdependency-url] [![Code Style][style-image]][style-url]\n\n\u003e A static site development workflow (Convention over Configuration)\n\n## Installation\n\n```shell\n$ yarn add x-pages --dev\n\n# or npm\n$ npm install x-pages --save-dev\n```\n\nin your package.json `scripts`:\n\n```json\n{\n  \"scripts\": {\n    \"clean\": \"x-pages clean\",\n    \"lint\": \"x-pages lint\",\n    \"serve\": \"x-pages serve\",\n    \"build\": \"x-pages build\",\n    \"start\": \"x-pages start\",\n    \"deploy\": \"x-pages deploy --production\"\n  }\n}\n```\n\nYou can also use the x-pages template provided by the [CAZ](https://github.com/zce/caz) scaffold tool to quickly generate a project that uses x-pages.\n\n```shell\n$ npx caz x-pages my-project\n```\n\n## CLI Usage\n\n```shell\n$ x-pages \u003ctask\u003e [options]\n```\n\n### e.g.\n\n```shell\n# Runs the app in development mode\n$ x-pages serve --port 5210 --open\n# Builds the app for production to the `dist` folder\n$ x-pages build --production\n```\n\n### Available Scripts\n\n#### `yarn lint` or `npm run lint`\n\nLint the styles \u0026 scripts files.\n\n#### `yarn compile` or `npm run compile`\n\nCompile the styles \u0026 scripts \u0026 pages file.\n\n#### `yarn serve` or `npm run serve`\n\nRuns the app in development mode with a automated server.\n\n##### options\n\n- `open`: Open browser on start, Default: `false`\n- `port`: Specify server port, Default: `2080`\n\n#### `yarn build` or `npm run build`\n\nBuilds the app for production to the `dist` folder. It minify source in production mode for the best performance.\n\n##### options\n\n- `production`: Production mode flag, Default: `false`\n- `prod`: Alias to `production`\n\n#### `yarn start` or `npm run start`\n\nRunning projects in production mode.\n\n##### options\n\n- `open`: Open browser on start, Default: `false`\n- `port`: Specify server port, Default: `2080`\n\n#### `yarn deploy` or `npm run deploy`\n\nDeploy the `dist` folder to [GitHub Pages](https://pages.github.com).\n\n##### options\n\n- `branch`: The name of the branch you'll be pushing to, Default: `'gh-pages'`\n\n#### `yarn clean` or `npm run clean`\n\nClean the `dist` \u0026 `temp` files.\n\n## Examples\n\n- [zce/pages-boilerplate#x-pages](https://github.com/zce/pages-boilerplate/tree/x-pages) - x-pages examples\n\n## Folder Structure\n\n```\n└── my-awesome-pages ································· project root\n   ├─ public ········································· static folder\n   │  └─ favicon.ico ································· static file (unprocessed)\n   ├─ src ············································ source folder\n   │  ├─ assets ······································ assets folder\n   │  │  ├─ fonts ···································· fonts folder\n   │  │  │  └─ pages.ttf ····························· font file (imagemin)\n   │  │  ├─ images ··································· images folder\n   │  │  │  └─ logo.png ······························ image file (imagemin)\n   │  │  ├─ scripts ·································· scripts folder\n   │  │  │  └─ main.js ······························· script file (babel / uglify)\n   │  │  └─ styles ··································· styles folder\n   │  │     ├─ _variables.scss ······················· partial sass file (dont output)\n   │  │     └─ main.scss ····························· entry scss file (scss / postcss)\n   │  ├─ layouts ····································· layouts folder\n   │  │  └─ basic.html ······························· layout file (dont output)\n   │  ├─ partials ···································· partials folder\n   │  │  └─ header.html ······························ partial file (dont output)\n   │  ├─ about.html ·································· page file (use layout \u0026 partials)\n   │  └─ index.html ·································· page file (use layout \u0026 partials)\n   ├─ .csscomb.json ·································· csscomb config file\n   ├─ .editorconfig ·································· editor config file\n   ├─ .gitignore ····································· git ignore file\n   ├─ .travis.yml ···································· travis ci config file\n   ├─ CHANGELOG.md ··································· repo changelog\n   ├─ LICENSE ········································ repo license\n   ├─ README.md ······································ repo readme\n   ├─ gulpfile.js ···································· gulp tasks file\n   ├─ package.json ··································· package file\n   └─ yarn.lock ······································ yarn lock file\n```\n\n## Related\n\n- [zce/pages-boilerplate](https://github.com/zce/pages-boilerplate) - Always a pleasure scaffolding your awesome static sites.\n\n## Contributing\n\n1. **Fork** it on GitHub!\n2. **Clone** the fork to your own machine.\n3. **Checkout** your feature branch: `git checkout -b my-awesome-feature`\n4. **Commit** your changes to your own branch: `git commit -am 'Add some feature'`\n5. **Push** your work back up to your fork: `git push -u origin my-awesome-feature`\n6. Submit a **Pull Request** so that we can review your changes.\n\n\u003e **NOTE**: Be sure to merge the latest from \"upstream\" before making a pull request!\n\n## License\n\n[MIT](LICENSE) \u0026copy; [汪磊](https://zce.me)\n\n[travis-image]: https://img.shields.io/travis/zce/x-pages/master.svg\n[travis-url]: https://travis-ci.org/zce/x-pages\n[downloads-image]: https://img.shields.io/npm/dm/x-pages.svg\n[downloads-url]: https://npmjs.org/package/x-pages\n[version-image]: https://img.shields.io/npm/v/x-pages.svg\n[version-url]: https://npmjs.org/package/x-pages\n[license-image]: https://img.shields.io/github/license/zce/x-pages.svg\n[license-url]: https://github.com/zce/x-pages/blob/master/LICENSE\n[dependency-image]: https://img.shields.io/david/zce/x-pages.svg\n[dependency-url]: https://david-dm.org/zce/x-pages\n[devdependency-image]: https://img.shields.io/david/dev/zce/x-pages.svg\n[devdependency-url]: https://david-dm.org/zce/x-pages?type=dev\n[style-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg\n[style-url]: http://standardjs.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzce%2Fx-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzce%2Fx-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzce%2Fx-pages/lists"}