{"id":16701161,"url":"https://github.com/scriptex/github-pages-vuepress","last_synced_at":"2025-09-01T05:32:19.322Z","repository":{"id":35168388,"uuid":"137197903","full_name":"scriptex/github-pages-vuepress","owner":"scriptex","description":"Build a static website using VuePress and deploy to Github Pages","archived":false,"fork":false,"pushed_at":"2025-08-20T20:14:15.000Z","size":3431,"stargazers_count":26,"open_issues_count":0,"forks_count":11,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-20T22:21:20.834Z","etag":null,"topics":["github-pages","static-site-generator","vuepress"],"latest_commit_sha":null,"homepage":"https://atanas.info/portfolio/open-source/github-pages-vuepress","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/scriptex.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,"zenodo":null},"funding":{"github":["scriptex"],"patreon":"atanas","open_collective":null,"ko_fi":"scriptex","tidelift":null,"community_bridge":null,"liberapay":"scriptex","issuehunt":"scriptex","otechie":null,"custom":["paypal.me/scriptex","revolut.me/scriptex"]}},"created_at":"2018-06-13T10:04:43.000Z","updated_at":"2025-08-20T20:14:16.000Z","dependencies_parsed_at":"2024-01-11T14:05:08.463Z","dependency_job_id":"dbcbd0a2-cbaf-448b-8e74-19291449ac3f","html_url":"https://github.com/scriptex/github-pages-vuepress","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/scriptex/github-pages-vuepress","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptex%2Fgithub-pages-vuepress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptex%2Fgithub-pages-vuepress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptex%2Fgithub-pages-vuepress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptex%2Fgithub-pages-vuepress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scriptex","download_url":"https://codeload.github.com/scriptex/github-pages-vuepress/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptex%2Fgithub-pages-vuepress/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273077227,"owners_count":25041358,"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-09-01T02:00:09.058Z","response_time":120,"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":["github-pages","static-site-generator","vuepress"],"created_at":"2024-10-12T18:29:03.754Z","updated_at":"2025-09-01T05:32:19.244Z","avatar_url":"https://github.com/scriptex.png","language":"JavaScript","readme":"[![Travis CI](https://travis-ci.com/scriptex/github-pages-vuepress.svg?branch=master)](https://travis-ci.com/scriptex/github-pages-vuepress)\n[![Github Build](https://github.com/scriptex/github-pages-vuepress/workflows/Build/badge.svg)](https://github.com/scriptex/github-pages-vuepress/actions?query=workflow%3ABuild)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/34d3d75710534dc6a38c3584a1dcd068)](https://www.codacy.com/gh/scriptex/github-pages-vuepress/dashboard?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=scriptex/github-pages-vuepress\u0026utm_campaign=Badge_Grade)\n[![Codebeat Badge](https://codebeat.co/badges/d765a4c8-2c0e-44f2-89c3-fa364fdc14e6)](https://codebeat.co/projects/github-com-scriptex-github-pages-vuepress-master)\n[![CodeFactor Badge](https://www.codefactor.io/repository/github/scriptex/github-pages-vuepress/badge)](https://www.codefactor.io/repository/github/scriptex/github-pages-vuepress)\n[![DeepScan grade](https://deepscan.io/api/teams/3574/projects/5257/branches/40799/badge/grade.svg)](https://deepscan.io/dashboard#view=project\u0026tid=3574\u0026pid=5257\u0026bid=40799)\n[![Analytics](https://ga-beacon-361907.ew.r.appspot.com/UA-83446952-1/github.com/scriptex/github-pages-vuepress/README.md?pixel)](https://github.com/scriptex/github-pages-vuepress/)\n\n# VuePress Github Pages\n\n\u003e Use [VuePress](https://vuepress.vuejs.org/) to built a static website and deploy on [Github Pages](https://pages.github.com/).\n\n## Visitor stats\n\n![GitHub stars](https://img.shields.io/github/stars/scriptex/github-pages-vuepress?style=social)\n![GitHub forks](https://img.shields.io/github/forks/scriptex/github-pages-vuepress?style=social)\n![GitHub watchers](https://img.shields.io/github/watchers/scriptex/github-pages-vuepress?style=social)\n![GitHub followers](https://img.shields.io/github/followers/scriptex?style=social)\n\n## Code stats\n\n![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/scriptex/github-pages-vuepress)\n![GitHub repo size](https://img.shields.io/github/repo-size/scriptex/github-pages-vuepress?style=plastic)\n![GitHub language count](https://img.shields.io/github/languages/count/scriptex/github-pages-vuepress?style=plastic)\n![GitHub top language](https://img.shields.io/github/languages/top/scriptex/github-pages-vuepress?style=plastic)\n![GitHub last commit](https://img.shields.io/github/last-commit/scriptex/github-pages-vuepress?style=plastic)\n\n## Start\n\nMake sure that you have NodeJS and NPM or Yarn installed.\n\nStart by forking or downloading this repository. If downloaded, extract the contents of the archive in a folder and navigate to that folder in your preferred terminal. Then:\n\n## Install\n\n```sh\nnpm install\n```\n\nor\n\n```sh\nyarn\n```\n\n## Develop\n\n```sh\nnpm run start\n```\n\nor\n\n```sh\nyarn start\n```\n\n## Build\n\n```sh\nnpm run build\n```\n\nor\n\n```sh\nyarn build\n```\n\n## Details\n\nThe `README.md` file in the root serves the purpose of `index.html` file.\n\nIf you wish to create new pages, you can do so by adding new `.md` files in the root.\n\nIf you wish to use a more complicated files/folders structure, make sure that you read and follow the [official docs](https://vuepress.vuejs.org/guide/directory-structure.html#default-page-routing) or just checkout how I did it in the [demo branch](https://github.com/scriptex/github-pages-vuepress/tree/demo)\n\nVuePress builds your static website in the `/docs` folder which is set to be used by Github Pages in the repository settings.\n\n**Important**\n\nYou can control the base dir of your site in the `.vuepress/config.js` file's `base` property.\n\n## Demo\n\nSee this page served via Gitlab Pages on https://scriptex.js.org/github-pages-vuepress/\n\n## Bonus: Theming\n\nVuepress uses [Stylus](http://stylus-lang.com/). It comes with default theme which can be easily overwritten.\nJust place your styles in the `.vuepress/styles` folder.\n\nHere are the **default theme** colors. Variables should go in the `palette.styl` file:\n\n```stylus\n$accentColor = #3eaf7c\n$textColor = #2c3e50\n$borderColor = #eaecef\n$codeBgColor = #282c34\n```\n\nHere are the colors and settings for a **Material Light** theme:\n\nVariables should go in the `palette.styl` file:\n\n```stylus\n$accentColor = #009688\n$textColor = #212121\n$borderColor = #bdbdbd\n$codeBgColor = #333\n$bgColor = #fff\n```\n\nThe rest of the styles should go in the `index.styl` file:\n\n```stylus\nhtml,\nbody,\n.navbar,\n.sidebar,\n.theme-container .navbar,\n.theme-container .sidebar\n\tbackground-color $bgColor\n\n.theme-container .search-box input\n\tcolor $codeBgColor\n\n.theme-container .search-box .suggestion a\n\tcolor $accentColor\n\n.theme-container .content code\n\tcolor $bgColor\n\tbackground-color $codeBgColor\n```\n\nHere are the color for a **Material Dark** theme (used in my personal website):\n\n```stylus\n/* .vuepress/styles/palette.styl */\n$accentColor = #ef4c23\n$textColor = #fff\n$borderColor = #bdbdbd\n$codeBgColor = #000\n$bgColor = #263238\n\n/* .vuepress/styles/index.styl */\nhtml,\nbody,\n.navbar,\n.sidebar,\n.theme-container .navbar,\n.theme-container .sidebar\n\tbackground-color $bgColor\n\n.theme-container .search-box input\n\tcolor: $codeBgColor\n\n.theme-container .search-box .suggestion a\n\tcolor: $accentColor\n\n.theme-container .content code\n\tbackground-color $codeBgColor\n```\n\n## LICENSE\n\nMIT\n\n---\n\n\u003cdiv align=\"center\"\u003e\n    Connect with me:\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://atanas.info\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/logo.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"mailto:hi@atanas.info\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/email.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://www.linkedin.com/in/scriptex/\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/linkedin.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://github.com/scriptex\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/github.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://gitlab.com/scriptex\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/gitlab.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://twitter.com/scriptexbg\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/twitter.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://www.npmjs.com/~scriptex\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/npm.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://www.youtube.com/user/scriptex\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/youtube.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://stackoverflow.com/users/4140082/atanas-atanasov\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/stackoverflow.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://codepen.io/scriptex/\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/codepen.svg\" width=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://profile.codersrank.io/user/scriptex\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/codersrank.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://linktr.ee/scriptex\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/linktree.svg\" height=\"20\" alt=\"\"\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n---\n\n\u003cdiv align=\"center\"\u003e\nSupport and sponsor my work:\n\u003cbr /\u003e\n\u003cbr /\u003e\n\u003ca href=\"https://twitter.com/intent/tweet?text=Checkout%20this%20awesome%20developer%20profile%3A\u0026url=https%3A%2F%2Fgithub.com%2Fscriptex\u0026via=scriptexbg\u0026hashtags=software%2Cgithub%2Ccode%2Cawesome\" title=\"Tweet\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/Tweet-Share_my_profile-blue.svg?logo=twitter\u0026color=38A1F3\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://paypal.me/scriptex\" title=\"Donate on Paypal\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/Donate-Support_me_on_PayPal-blue.svg?logo=paypal\u0026color=222d65\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://revolut.me/scriptex\" title=\"Donate on Revolut\"\u003e\n\t\u003cimg src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/revolut.json\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://patreon.com/atanas\" title=\"Become a Patron\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/Become_Patron-Support_me_on_Patreon-blue.svg?logo=patreon\u0026color=e64413\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://ko-fi.com/scriptex\" title=\"Buy Me A Coffee\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-yellow.svg?logo=ko-fi\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://liberapay.com/scriptex/donate\" title=\"Donate on Liberapay\"\u003e\n\t\u003cimg src=\"https://img.shields.io/liberapay/receives/scriptex?label=Donate%20on%20Liberapay\u0026logo=liberapay\" /\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/bitcoin.json\" title=\"Donate Bitcoin\"\u003e\n\t\u003cimg src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/bitcoin.json\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/etherium.json\" title=\"Donate Etherium\"\u003e\n\t\u003cimg src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/etherium.json\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/shiba-inu.json\" title=\"Donate Shiba Inu\"\u003e\n\t\u003cimg src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/shiba-inu.json\" /\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n","funding_links":["https://github.com/sponsors/scriptex","https://patreon.com/atanas","https://ko-fi.com/scriptex","https://liberapay.com/scriptex","https://issuehunt.io/r/scriptex","paypal.me/scriptex","revolut.me/scriptex","https://paypal.me/scriptex","https://liberapay.com/scriptex/donate"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscriptex%2Fgithub-pages-vuepress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscriptex%2Fgithub-pages-vuepress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscriptex%2Fgithub-pages-vuepress/lists"}