{"id":17958513,"url":"https://github.com/cookieY/guide","last_synced_at":"2025-03-25T03:31:03.900Z","repository":{"id":108285712,"uuid":"489302506","full_name":"cookieY/guide","owner":"cookieY","description":"next Yearning doc","archived":false,"fork":false,"pushed_at":"2024-11-05T02:03:57.000Z","size":15707,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"next","last_synced_at":"2025-02-24T10:47:01.208Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cookieY.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2022-05-06T09:55:04.000Z","updated_at":"2024-11-05T02:01:07.000Z","dependencies_parsed_at":"2024-09-13T00:12:23.060Z","dependency_job_id":"f1fc51c6-c21d-4559-b4d0-524afe86b566","html_url":"https://github.com/cookieY/guide","commit_stats":null,"previous_names":["cookiey/guide","cookiey/yearning_doc"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cookieY%2Fguide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cookieY%2Fguide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cookieY%2Fguide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cookieY%2Fguide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cookieY","download_url":"https://codeload.github.com/cookieY/guide/tar.gz/refs/heads/next","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245394543,"owners_count":20608115,"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":[],"created_at":"2024-10-29T11:00:32.646Z","updated_at":"2025-03-25T03:31:03.877Z","avatar_url":"https://github.com/cookieY.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# yearning-guide\n\nThe Site is generated using [vuepress](https://vuepress.vuejs.org/) and [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume)\n\n## Install\n\n```sh\npnpm i\n```\n\n## Usage\n\n```sh\n# start dev server\npnpm docs:dev\n# build for production\npnpm docs:build\n# preview production build in local\npnpm docs:preview\n# update vuepress and theme\npnpm vp-update\n```\n\n## Deploy to GitHub Pages\n\nThe plume theme has been created with GitHub Actions: `.github/workflows/docs-deploy.yml`. You also need to make the following settings in the GitHub repository:\n\n- [ ] `settings \u003e Actions \u003e General`, Scroll to the bottom of the page, under `Workflow permissions`, check `Read and write permissions`, and click the save button.\n\n- [ ] `settings \u003e Pages`, In `Build and deployment`, select `Deploy from a branch` for `Source`, choose `gh-pages` for `Branch`, and click the save button.\n  (The `gh-pages` branch may not exist upon first creation. You can complete the above setup first, push the code to the main branch, wait for `github actions` to finish, and then proceed with the setup.)\n\n- [ ] Modify the `base` option in `docs/.vuepress/config.ts`:\n  - If you are planning to deploy to `https://\u003cUSERNAME\u003e.github.io/`, you can skip this step as `base` defaults to `\"/\"`.\n  - If you are planning to deploy to `https://\u003cUSERNAME\u003e.github.io/\u003cREPO\u003e/`, meaning your repository URL is `https://github.com/\u003cUSERNAME\u003e/\u003cREPO\u003e`, set `base` to `\"/\u003cREPO\u003e/\"`.\n\nTo customize a domain name, please refer to [Github Pages](https://docs.github.com/zh/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages)\n\n## Documents\n\n- [vuepress](https://vuepress.vuejs.org/)\n- [vuepress-theme-plume](https://theme-plume.vuejs.press/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FcookieY%2Fguide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FcookieY%2Fguide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FcookieY%2Fguide/lists"}