diff --git a/.github/workflows/build-deploy.yml b/.github/workflows/build-deploy.yml index 0b5f654..46bb255 100644 --- a/.github/workflows/build-deploy.yml +++ b/.github/workflows/build-deploy.yml @@ -30,33 +30,4 @@ jobs: ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }} # toKen私密变量 with: folder: docs/.vuepress/dist - branch: gh-pages # 部署到的分支 - - test_website: - needs: deploy - runs-on: ubuntu-20.04 - steps: - - name: Test Connect - run: | - curl https://eryajf.github.io/HowToStartOpenSource/ --connect-timeout 5 - curl https://ms-d5d5d07c4cab-1961.sgp.meilisearch.io/health --connect-timeout 5 - - scrape-docs: - needs: test_website - runs-on: ubuntu-20.04 - steps: - - uses: actions/checkout@v2 - - uses: actions/setup-node@v2 - with: - node-version: 14 - registry-url: https://registry.npmjs.org/ - - name: Run docs-scraper - env: - API_KEY: ${{ secrets.MEILISEARCH_API_KEY }} - CONFIG_FILE_PATH: ${{ github.workspace }}/docs/.vuepress/public/data/docs-scraper-config.json - run: | - docker run -t --rm \ - -e MEILISEARCH_HOST_URL="https://ms-d5d5d07c4cab-1961.sgp.meilisearch.io" \ - -e MEILISEARCH_API_KEY=$API_KEY \ - -v $CONFIG_FILE_PATH:/docs-scraper/config.json \ - getmeili/docs-scraper:v0.12.7 pipenv run ./docs_scraper config.json \ No newline at end of file + branch: gh-pages # 部署到的分支 \ No newline at end of file diff --git a/.gitignore b/.gitignore index 36bf2f9..2483d5c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,11 @@ +# vuepress +docs/.vuepress/.cache +docs/.vuepress/.temp +docs/.vuepress/dist +node_modules + # npm package-lock.json -node_modules # yarn yarn.lock @@ -8,12 +13,6 @@ yarn.lock # vscode .vscode -# vuepress -docs/.vuepress/dist - -# 百度链接推送 -urls.txt - # mac .DS_Store yarn-error.log \ No newline at end of file diff --git a/docs/.vuepress/components/Card.vue b/docs/.vuepress/components/Card.vue deleted file mode 100644 index a4c221b..0000000 --- a/docs/.vuepress/components/Card.vue +++ /dev/null @@ -1,41 +0,0 @@ - - - - diff --git a/docs/.vuepress/components/Contributors.vue b/docs/.vuepress/components/Contributors.vue deleted file mode 100644 index 50b3d54..0000000 --- a/docs/.vuepress/components/Contributors.vue +++ /dev/null @@ -1,100 +0,0 @@ - - - - - \ No newline at end of file diff --git a/docs/.vuepress/components/CustomBanner.vue b/docs/.vuepress/components/CustomBanner.vue new file mode 100644 index 0000000..ef59f58 --- /dev/null +++ b/docs/.vuepress/components/CustomBanner.vue @@ -0,0 +1,91 @@ + + + + + diff --git a/docs/.vuepress/components/Examples.vue b/docs/.vuepress/components/Examples.vue new file mode 100644 index 0000000..760c1dd --- /dev/null +++ b/docs/.vuepress/components/Examples.vue @@ -0,0 +1,96 @@ + + + + + diff --git a/docs/.vuepress/components/GitHubLink.vue b/docs/.vuepress/components/GitHubLink.vue deleted file mode 100644 index 5845897..0000000 --- a/docs/.vuepress/components/GitHubLink.vue +++ /dev/null @@ -1,48 +0,0 @@ -// based on -// https://github.com/vuepress/vuepress-community/blob/master/packages/docs/src/.vuepress/components/GitHubLink.vue - - - - - - \ No newline at end of file diff --git a/docs/.vuepress/components/HomePageOne.vue b/docs/.vuepress/components/HomePageOne.vue deleted file mode 100644 index e780d01..0000000 --- a/docs/.vuepress/components/HomePageOne.vue +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - diff --git a/docs/.vuepress/components/NpmLink.vue b/docs/.vuepress/components/NpmLink.vue deleted file mode 100644 index a62ee8a..0000000 --- a/docs/.vuepress/components/NpmLink.vue +++ /dev/null @@ -1,29 +0,0 @@ -// based on -// https://github.com/vuepress/vuepress-community/blob/master/packages/docs/src/.vuepress/components/NpmLink.vue - - - - \ No newline at end of file diff --git a/docs/.vuepress/components/icon-example.vue b/docs/.vuepress/components/icon-example.vue deleted file mode 100644 index bb70266..0000000 --- a/docs/.vuepress/components/icon-example.vue +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/docs/.vuepress/components/images/2020/content.svg b/docs/.vuepress/components/images/2020/content.svg deleted file mode 100644 index b9cf3e2..0000000 --- a/docs/.vuepress/components/images/2020/content.svg +++ /dev/null @@ -1 +0,0 @@ -content \ No newline at end of file diff --git a/docs/.vuepress/components/images/2020/mobilelife.svg b/docs/.vuepress/components/images/2020/mobilelife.svg deleted file mode 100644 index 509b73e..0000000 --- a/docs/.vuepress/components/images/2020/mobilelife.svg +++ /dev/null @@ -1 +0,0 @@ -mobile life \ No newline at end of file diff --git a/docs/.vuepress/components/images/2020/newyear.svg b/docs/.vuepress/components/images/2020/newyear.svg deleted file mode 100644 index f4fc263..0000000 --- a/docs/.vuepress/components/images/2020/newyear.svg +++ /dev/null @@ -1 +0,0 @@ -new_decade \ No newline at end of file diff --git a/docs/.vuepress/components/images/2020/snowman.svg b/docs/.vuepress/components/images/2020/snowman.svg deleted file mode 100644 index c333105..0000000 --- a/docs/.vuepress/components/images/2020/snowman.svg +++ /dev/null @@ -1 +0,0 @@ -snow_games \ No newline at end of file diff --git a/docs/.vuepress/components/images/blog.svg b/docs/.vuepress/components/images/blog.svg deleted file mode 100644 index f197679..0000000 --- a/docs/.vuepress/components/images/blog.svg +++ /dev/null @@ -1 +0,0 @@ -fashion blogging \ No newline at end of file diff --git a/docs/.vuepress/components/images/today.svg b/docs/.vuepress/components/images/today.svg deleted file mode 100644 index b9789b9..0000000 --- a/docs/.vuepress/components/images/today.svg +++ /dev/null @@ -1 +0,0 @@ -landing page \ No newline at end of file diff --git a/docs/.vuepress/components/images/tomorrow.svg b/docs/.vuepress/components/images/tomorrow.svg deleted file mode 100644 index 9c7eb0d..0000000 --- a/docs/.vuepress/components/images/tomorrow.svg +++ /dev/null @@ -1 +0,0 @@ -work_together \ No newline at end of file diff --git a/docs/.vuepress/components/images/yesterday.svg b/docs/.vuepress/components/images/yesterday.svg deleted file mode 100644 index 0f6b061..0000000 --- a/docs/.vuepress/components/images/yesterday.svg +++ /dev/null @@ -1 +0,0 @@ -programming \ No newline at end of file diff --git a/docs/.vuepress/components/md5.vue b/docs/.vuepress/components/md5.vue index e85dd29..5fedc39 100644 --- a/docs/.vuepress/components/md5.vue +++ b/docs/.vuepress/components/md5.vue @@ -1,36 +1,93 @@ - - diff --git a/docs/.vuepress/components/plugins-recommend.vue b/docs/.vuepress/components/plugins-recommend.vue deleted file mode 100644 index 218aee9..0000000 --- a/docs/.vuepress/components/plugins-recommend.vue +++ /dev/null @@ -1,200 +0,0 @@ - - - - - - - diff --git a/docs/.vuepress/components/theme-example.vue b/docs/.vuepress/components/theme-example.vue deleted file mode 100644 index 90751da..0000000 --- a/docs/.vuepress/components/theme-example.vue +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js deleted file mode 100644 index 9cc29ff..0000000 --- a/docs/.vuepress/config.js +++ /dev/null @@ -1,76 +0,0 @@ -const path = require('path') -const themeConfig = require('./config/theme/') - -module.exports = { - dest: 'docs/.vuepress/dist', - base: '/HowToStartOpenSource/', - head: [ - ['link', { rel: 'icon', href: '/favicon.ico' }], - ['meta', { name: 'viewport', content: 'width=device-width,initial-scale=1,user-scalable=no' }], - ['meta', { name: 'author', content: 'eryajf' }], - ['meta', { name: 'keywords', content: 'vuepress,reco,eryajf,github,HowToStartOpenSource,二丫讲梵' }], - ['link', { rel: 'manifest', href: '/manifest.json' }], - ['meta', { name: 'theme-color', content: '#42b983' }], - ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }], - ['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }], - ['link', { rel: 'apple-touch-icon', href: '/logo.png' }], - ['link', { rel: 'mask-icon', href: '/logo.png', color: '#42b983' }], - ['meta', { name: 'msapplication-TileImage', content: '/logo.png' }], - ['meta', { name: 'msapplication-TileColor', content: '#000000' }], - ], - theme: 'reco', - themeConfig, - locales: { - '/': { - lang: 'zh-CN', // 将会被设置为 的 lang 属性 - title: "HowToStartOpenSource", - description: '⚗️ GitHub开源项目维护协作指南。' - }, - '/en/': { - lang: 'en-US', - title: "HowToStartOpenSource", - description: '⚗️ GitHub Open source project maintenance collaboration guide.' - } - }, - markdown: { - // lineNumbers: true - }, - plugins: [ - // 添加sitemap - [ - 'sitemap', { - hostname: 'https://eryajf.github.io/HowToStartOpenSource/', - exclude: ["/404.html"], - }, - ], - // 一键复制 - [ - 'one-click-copy', - { - // 代码块复制按钮 - copySelector: ['div[class*="language-"] pre', 'div[class*="aside-code"] aside'], // String or Array - copyMessage: '复制成功', // default is 'Copy successfully and then paste it for use.' - duration: 1000, // prompt message display time. - showInMobile: false, // whether to display on the mobile side, default: false. - }, - ], - // 全文搜索插件 meilisearch - [ - 'vuepress-plugin-meilisearch', - { - hostUrl: 'https://ms-d5d5d07c4cab-1961.sgp.meilisearch.io', // meilisearch 服务端域名 - apiKey: "575b81b52d62c70a11367b8c4bdc1cb2532270d89381d2da7fb0ebd6b7c7f675", // 只有搜索权限的 key - indexUid: 'howtoStartOpenSource', - placeholder: '按下 𝑺 或 / 搜索', - maxSuggestions: 9, // 最多显示几个搜索结果 - cropLength: 30, // 每个搜索结果最多显示多少个字符 - }, - ], - '@vuepress-reco/extract-code', - 'flowchart', - ['@vuepress-reco/rss', { - site_url: 'https://eryajf.github.io/HowToStartOpenSource/', - copyright: 'eryajf' - }] - ] -} diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts new file mode 100644 index 0000000..1459c77 --- /dev/null +++ b/docs/.vuepress/config.ts @@ -0,0 +1,22 @@ +import { defineUserConfig } from 'vuepress' +import { recoTheme } from 'vuepress-theme-reco' +import { themeConfig } from './config/index' + +export default defineUserConfig({ + locales: { + // 键名是该语言所属的子路径 + // 作为特例,默认语言可以使用 '/' 作为其路径。 + '/': { + lang: 'zh-CN', // 将会被设置为 的 lang 属性 + title: "HowToSOS", + description: '⚗️ GitHub开源项目维护协作指南。' + }, + '/en/': { + lang: 'en-US', + title: "HowToSOS", + description: '⚗️ GitHub Open source project maintenance collaboration guide.' + } + }, + theme: recoTheme(themeConfig), + // debug: true, +}) diff --git a/docs/.vuepress/config/en/commentConfig.ts b/docs/.vuepress/config/en/commentConfig.ts new file mode 100644 index 0000000..1005acd --- /dev/null +++ b/docs/.vuepress/config/en/commentConfig.ts @@ -0,0 +1,12 @@ +export const commentConfig = { + type: 'valine', + options: { + appId: '', + appKey: '', + placeholder: 'Fill in the email can receive a reply reminder!', + verify: true, // 验证码服务 + // notify: true, + recordIP: true, + hideComments: true, // 隐藏评论 + }, +} diff --git a/docs/.vuepress/config/en/index.ts b/docs/.vuepress/config/en/index.ts new file mode 100644 index 0000000..95f38ca --- /dev/null +++ b/docs/.vuepress/config/en/index.ts @@ -0,0 +1,4 @@ +// export * from './bulletin' +export * from './commentConfig' +export * from './navbar' +export * from './series' diff --git a/docs/.vuepress/config/en/navbar.ts b/docs/.vuepress/config/en/navbar.ts new file mode 100644 index 0000000..5566533 --- /dev/null +++ b/docs/.vuepress/config/en/navbar.ts @@ -0,0 +1,8 @@ +export const navbar = [ + { text: 'basic-content', link: '/en/HowToStartOpenSource/01-basic-content/01-basic-configuration', icon: 'reco-blog' }, + { text: 'Github-Actions', link: '/en/HowToStartOpenSource/02-github-actions/01-Automatically-add-TOC-directories-for-README' , icon: 'reco-up'}, + { text: 'Github-Tips', link: '/en/HowToStartOpenSource/03-github-tips/01-How-to-center-the-table-in-README',icon: 'reco-three' }, + { text: 'myopensource', link: '/en/HowToStartOpenSource/other/myopensource',icon: 'reco-github' }, + // { text: 'RSS', link: 'https://eryajf.github.io/HowToStartOpenSource/rss.xml', icon: 'reco-rss'}, + { text: 'GitHub', link: 'https://github.com/eryajf/HowToStartOpenSource', icon: 'reco-github'} +] diff --git a/docs/.vuepress/config/en/series.ts b/docs/.vuepress/config/en/series.ts new file mode 100644 index 0000000..20a1c92 --- /dev/null +++ b/docs/.vuepress/config/en/series.ts @@ -0,0 +1,46 @@ +export const series = { + '/en/HowToStartOpenSource/': [{ + text: 'basic content', + children: [ + '/en/HowToStartOpenSource/01-basic-content/01-basic-configuration', + '/en/HowToStartOpenSource/01-basic-content/02-personal-maintenance-process', + '/en/HowToStartOpenSource/01-basic-content/03-collaborative-development-process', + '/en/HowToStartOpenSource/01-basic-content/04-PR-and-issue', + '/en/HowToStartOpenSource/01-basic-content/05-How-to-configure-a-personal-GitHub-home-page-with-elegance-and-beauty', + '/en/HowToStartOpenSource/01-basic-content/06-issue-and-PR-template', + ], + }, + { + text: 'GitHub Action', + children: [ + '/en/HowToStartOpenSource/02-github-actions/01-Automatically-add-TOC-directories-for-README', + '/en/HowToStartOpenSource/02-github-actions/02-Automatically-add-the-list-of-project-contributors-to-README', + '/en/HowToStartOpenSource/02-github-actions/03-Automatically-and-elegantly-build-Releases-for-the-project', + '/en/HowToStartOpenSource/02-github-actions/04-Automatically-get-blog-rss-articles', + '/en/HowToStartOpenSource/02-github-actions/05-Automatically-build-docker-images-compatible-with-multi-CPU-architecture-and-publish-to-DockerHub', + '/en/HowToStartOpenSource/02-github-actions/06-Automatically-perform-code-scan-pre-check', + '/en/HowToStartOpenSource/02-github-actions/07-Automatically-generate-Fans-for-GitHub', + '/en/HowToStartOpenSource/02-github-actions/08-Automatically-generate-a-personal-star-list-and-classify-it', + '/en/HowToStartOpenSource/02-github-actions/09-Automatically-get-the-project-current-star-and-fork-to-write-to-Description', + '/en/HowToStartOpenSource/02-github-actions/10-Automatic-lossless-compression-of-pictures-in-the-warehouse', + '/en/HowToStartOpenSource/02-github-actions/11-Automatically-detect-problem-links-in-the-project', + '/en/HowToStartOpenSource/02-github-actions/12-Automatically-build-binary-to-release-of-go-project', + ], + }, + { + text: 'GitHub Tips', + children: [ + '/en/HowToStartOpenSource/03-github-tips/01-How-to-center-the-table-in-README', + '/en/HowToStartOpenSource/03-github-tips/02-How-to-configure-multiple-GitHub-accounts-on-one-computer', + '/en/HowToStartOpenSource/03-github-tips/03-How-to-merge-multiple-submissions-into-one', + '/en/HowToStartOpenSource/03-github-tips/04-The-skill-of-reading-code-and-running-code', + '/en/HowToStartOpenSource/03-github-tips/05-Summary-using-GitHub-keyboard-shortcuts', + '/en/HowToStartOpenSource/03-github-tips/06-Summary-and-arrangement-of-personal-open-source-project-recommendation-platform', + '/en/HowToStartOpenSource/03-github-tips/07-How-to-bind-a-custom-domain-name-to-GitHub-Pages', + '/en/HowToStartOpenSource/03-github-tips/08-How-to-deal-with-the-problem-that-file-name-conversion-case-cannot-be-submitted-in-Git', + '/en/HowToStartOpenSource/03-github-tips/09-How-to-use-pre-commit-to-standardize-coding', + '/en/HowToStartOpenSource/03-github-tips/10-Use-github-slug-action-to-leak-key-variables-in-the-Github-Action-context', + ], + }, + ], +} diff --git a/docs/.vuepress/config/index.ts b/docs/.vuepress/config/index.ts new file mode 100644 index 0000000..18d3aba --- /dev/null +++ b/docs/.vuepress/config/index.ts @@ -0,0 +1,31 @@ +import * as zhConfig from './zh' +import * as enConfig from './en' + +export const themeConfig = { + locales: { + '/': { + selectLanguageText: '选择语言', + selectLanguageName: '简体中文', + lastUpdatedText: '最后更新时间', + navbar: zhConfig.navbar, + series: zhConfig.series, + commentConfig: zhConfig.commentConfig, + }, + '/en/': { + selectLanguageText: 'Languages', + selectLanguageName: 'English', + navbar: enConfig.navbar, + series: enConfig.series, + commentConfig: enConfig.commentConfig, + }, + }, + // autoSetSeries: true, + // logo: '/logo.png', + base: '/HowToStartOpenSource/', + author: 'eryajf', + docsRepo: 'https://github.com/eryajf/HowToStartOpenSource', + docsBranch: 'main', + docsDir: '/docs', + // vuePreviewsDir: './docs/.vuepress/vue-previews', + componentsDir: './docs/.vuepress/components', +} diff --git a/docs/.vuepress/config/locales/index.js b/docs/.vuepress/config/locales/index.js deleted file mode 100644 index 9c9f92a..0000000 --- a/docs/.vuepress/config/locales/index.js +++ /dev/null @@ -1,61 +0,0 @@ -const nav = require('../nav/') -const sidebar = require('../sidebar/') -module.exports = { - // 键名是该语言所属的子路径 - // 作为特例,默认语言可以使用 '/' 作为其路径。 - '/': { - // 多语言下拉菜单的标题 - selectText: 'language', - // 该语言在下拉菜单中的标签 - label: '简体中文', - // 编辑链接文字 - editLinkText: '在 GitHub 上编辑此页', - // Service Worker 的配置 - serviceWorker: { - updatePopup: { - message: "发现新内容可用.", - buttonText: "刷新" - } - }, - // 当前 locale 的 algolia docsearch 选项 - // algolia: { - // start_urls: [ - // { - // "url": "https://vuepress-theme-reco.recoluan.com/" - // } - // ], - // apiKey: '97357e58cac743c6de62036cb152f18b', - // indexName: 'vuepress-theme-reco' - // // inputSelector: '### REPLACE ME ####', - // // algoliaOptions: { 'facetFilters': ["lang:$LANG"] }, - // // debug: false // Set debug to true if you want to inspect the dropdown - // }, - nav: nav.zh, - sidebar: sidebar.zh - }, - '/en/': { - selectText: '语言', - label: 'English', - editLinkText: 'Edit this page on GitHub', - serviceWorker: { - updatePopup: { - message: "New content is available.", - buttonText: "Refresh" - } - }, - // algolia: { - // start_urls: [ - // { - // "url": "https://vuepress-theme-reco.recoluan.com/en/" - // } - // ], - // apiKey: '97357e58cac743c6de62036cb152f18b', - // indexName: 'vuepress-theme-reco' - // // inputSelector: '### REPLACE ME ####', - // // algoliaOptions: { 'facetFilters': ["lang:$LANG"] }, - // // debug: false // Set debug to true if you want to inspect the dropdown - // }, - nav: nav.en, - sidebar: sidebar.en - } -} \ No newline at end of file diff --git a/docs/.vuepress/config/nav/index.js b/docs/.vuepress/config/nav/index.js deleted file mode 100644 index 43391ef..0000000 --- a/docs/.vuepress/config/nav/index.js +++ /dev/null @@ -1,18 +0,0 @@ -module.exports = { - 'zh': [ - { text: '基础内容', link: '/views/01-basic-content/01-basic-configuration', icon: 'reco-blog' }, - { text: 'Github-Actions', link: '/views/02-github-actions/01-Automatically-add-TOC-directories-for-README', icon: 'reco-up' }, - { text: 'Github-Tips', link: '/views/03-github-tips/01-How-to-center-the-table-in-README', icon: 'reco-three' }, - { text: '我的项目', link: '/views/other/myopensource', icon: 'reco-github' }, - { text: '订阅', link: 'https://eryajf.github.io/HowToStartOpenSource/rss.xml', icon: 'reco-rss'}, - { text: 'GitHub', link: 'https://github.com/eryajf/HowToStartOpenSource', icon: 'reco-github'} - ], - 'en': [ - { text: 'basic-content', link: '/en/views/01-basic-content/01-basic-configuration', icon: 'reco-blog' }, - { text: 'Github-Actions', link: '/en/views/02-github-actions/01-Automatically-add-TOC-directories-for-README' , icon: 'reco-up'}, - { text: 'Github-Tips', link: '/en/views/03-github-tips/01-How-to-center-the-table-in-README',icon: 'reco-three' }, - { text: 'myopensource', link: '/en/views/other/myopensource',icon: 'reco-github' }, - { text: 'RSS', link: 'https://eryajf.github.io/HowToStartOpenSource/rss.xml', icon: 'reco-rss'}, - { text: 'GitHub', link: 'https://github.com/eryajf/HowToStartOpenSource', icon: 'reco-github'} - ] -} \ No newline at end of file diff --git a/docs/.vuepress/config/sidebar/index.js b/docs/.vuepress/config/sidebar/index.js deleted file mode 100644 index e51950a..0000000 --- a/docs/.vuepress/config/sidebar/index.js +++ /dev/null @@ -1,110 +0,0 @@ -module.exports = { - 'zh': Object.assign({}, { - '/views/01-basic-content/': [ - { - title: '基础内容', - collapsable: true, - children: [ - '01-basic-configuration', - '02-personal-maintenance-process', - '03-collaborative-development-process', - '04-PR-and-issue', - '05-How-to-configure-a-personal-GitHub-home-page-with-elegance-and-beauty', - '06-issue-and-PR-template' - ] - } - ], - '/views/02-github-actions/': [ - { - title: 'Github-Actions', - collapsable: true, - children: [ - '01-Automatically-add-TOC-directories-for-README', - '02-Automatically-add-the-list-of-project-contributors-to-README', - '03-Automatically-and-elegantly-build-Releases-for-the-project', - '04-Automatically-get-blog-rss-articles', - '05-Automatically-build-docker-images-compatible-with-multi-CPU-architecture-and-publish-to-DockerHub', - '06-Automatically-perform-code-scan-pre-check', - '07-Automatically-generate-Fans-for-GitHub', - '08-Automatically-generate-a-personal-star-list-and-classify-it', - '09-Automatically-get-the-project-current-star-and-fork-to-write-to-Description', - '10-Automatic-lossless-compression-of-pictures-in-the-warehouse', - '11-Automatically-detect-problem-links-in-the-project', - '12-Automatically-build-binary-to-release-of-go-project' - ] - } - ], - '/views/03-github-tips/': [ - { - title: 'Github-Tips', - collapsable: true, - children: [ - '01-How-to-center-the-table-in-README', - '02-How-to-configure-multiple-GitHub-accounts-on-one-computer', - '03-How-to-merge-multiple-submissions-into-one', - '04-The-skill-of-reading-code-and-running-code', - '05-Summary-using-GitHub-keyboard-shortcuts', - '06-Summary-and-arrangement-of-personal-open-source-project-recommendation-platform', - '07-How-to-bind-a-custom-domain-name-to-GitHub-Pages', - '08-How-to-deal-with-the-problem-that-file-name-conversion-case-cannot-be-submitted-in-Git', - '09-How-to-use-pre-commit-to-standardize-coding', - '10-Use-github-slug-action-to-leak-key-variables-in-the-Github-Action-context' - ] - } - ] - }), - 'en': Object.assign({}, { - '/en/views/01-basic-content/': [ - { - title: 'basic content', - collapsable: true, - children: [ - '01-basic-configuration', - '02-personal-maintenance-process', - '03-collaborative-development-process', - '04-PR-and-issue', - '05-How-to-configure-a-personal-GitHub-home-page-with-elegance-and-beauty', - '06-issue-and-PR-template' - ] - } - ], - '/en/views/02-github-actions/': [ - { - title: 'Github-Actions', - collapsable: true, - children: [ - '01-Automatically-add-TOC-directories-for-README', - '02-Automatically-add-the-list-of-project-contributors-to-README', - '03-Automatically-and-elegantly-build-Releases-for-the-project', - '04-Automatically-get-blog-rss-articles', - '05-Automatically-build-docker-images-compatible-with-multi-CPU-architecture-and-publish-to-DockerHub', - '06-Automatically-perform-code-scan-pre-check', - '07-Automatically-generate-Fans-for-GitHub', - '08-Automatically-generate-a-personal-star-list-and-classify-it', - '09-Automatically-get-the-project-current-star-and-fork-to-write-to-Description', - '10-Automatic-lossless-compression-of-pictures-in-the-warehouse', - '11-Automatically-detect-problem-links-in-the-project', - '12-Automatically-build-binary-to-release-of-go-project' - ] - } - ], - '/en/views/03-github-tips/': [ - { - title: 'Github-Tips', - collapsable: true, - children: [ - '01-How-to-center-the-table-in-README', - '02-How-to-configure-multiple-GitHub-accounts-on-one-computer', - '03-How-to-merge-multiple-submissions-into-one', - '04-The-skill-of-reading-code-and-running-code', - '05-Summary-using-GitHub-keyboard-shortcuts', - '06-Summary-and-arrangement-of-personal-open-source-project-recommendation-platform', - '07-How-to-bind-a-custom-domain-name-to-GitHub-Pages', - '08-How-to-deal-with-the-problem-that-file-name-conversion-case-cannot-be-submitted-in-Git', - '09-How-to-use-pre-commit-to-standardize-coding', - '10-Use-github-slug-action-to-leak-key-variables-in-the-Github-Action-context' - ] - } - ] - }) -} \ No newline at end of file diff --git a/docs/.vuepress/config/theme/index.js b/docs/.vuepress/config/theme/index.js deleted file mode 100644 index 9222b50..0000000 --- a/docs/.vuepress/config/theme/index.js +++ /dev/null @@ -1,9 +0,0 @@ -const themeReco = require('./themeReco.js') - -const sidebar = require('../sidebar/') -const locales = require('../locales/') - -module.exports = Object.assign({}, themeReco, { - sidebar, - locales -}) \ No newline at end of file diff --git a/docs/.vuepress/config/theme/themeReco.js b/docs/.vuepress/config/theme/themeReco.js deleted file mode 100644 index d4c44e0..0000000 --- a/docs/.vuepress/config/theme/themeReco.js +++ /dev/null @@ -1,28 +0,0 @@ -module.exports = { - type: 'HomePageOne', - // logo: '/logo.png', - // 搜索设置 - search: true, - searchMaxSuggestions: 10, - // 右侧边栏的TOC - subSidebar: 'auto', - // 自动形成侧边导航 - sidebar: 'auto', - // 最后更新时间 - lastUpdated: 'Last Updated', // string | boolean - // 作者 - author: 'eryajf', - authorAvatar: '/head.png', - // 项目开始时间 - startYear: '2022', - // 假定是 GitHub. 同时也可以是一个完整的 GitLab URL - repo: 'eryajf/HowToStartOpenSource', - // 假如文档不是放在仓库的根目录下: - docsDir: 'docs', - // 假如文档放在一个特定的分支下: - docsBranch: 'main', - // 默认是 false, 设置为 true 来启用 - editLinks: true, - mode: 'light', - codeTheme: 'tomorrow' -} \ No newline at end of file diff --git a/docs/.vuepress/config/zh/commentConfig.ts b/docs/.vuepress/config/zh/commentConfig.ts new file mode 100644 index 0000000..f2e5d78 --- /dev/null +++ b/docs/.vuepress/config/zh/commentConfig.ts @@ -0,0 +1,21 @@ +export const commentConfig = { + type: 'valine', + options: { + appId: '', + appKey: '', + placeholder: '填写邮箱可以收到回复提醒哦!', + verify: true, // 验证码服务 + // notify: true, + recordIP: true, + hideComments: true, // 隐藏评论 + }, + // type: 'giscus', + // options: { + // repo: 'vuepress-reco/docs-v2', + // repoId: 'R_kgDOGwsq6A', + // category: 'Comments', + // categoryId: 'DIC_kwDOGwsq6M4CWm89', + // mapping: 'title', + // hideComments: true, // 全局隐藏评论,默认 false + // }, +} diff --git a/docs/.vuepress/config/zh/index.ts b/docs/.vuepress/config/zh/index.ts new file mode 100644 index 0000000..95f38ca --- /dev/null +++ b/docs/.vuepress/config/zh/index.ts @@ -0,0 +1,4 @@ +// export * from './bulletin' +export * from './commentConfig' +export * from './navbar' +export * from './series' diff --git a/docs/.vuepress/config/zh/navbar.ts b/docs/.vuepress/config/zh/navbar.ts new file mode 100644 index 0000000..eb4cd31 --- /dev/null +++ b/docs/.vuepress/config/zh/navbar.ts @@ -0,0 +1,8 @@ +export const navbar = [ + { text: '基础内容', link: '/HowToStartOpenSource/01-basic-content/01-basic-configuration', icon: 'reco-blog' }, + { text: 'Github-Actions', link: '/HowToStartOpenSource/02-github-actions/01-Automatically-add-TOC-directories-for-README', icon: 'reco-up' }, + { text: 'Github-Tips', link: '/HowToStartOpenSource/03-github-tips/01-How-to-center-the-table-in-README', icon: 'reco-three' }, + { text: '我的项目', link: '/HowToStartOpenSource/other/myopensource', icon: 'reco-github' }, + // { text: '订阅', link: 'https://eryajf.github.io/HowToStartOpenSource/rss.xml', icon: 'reco-rss'}, + { text: 'GitHub', link: 'https://github.com/eryajf/HowToStartOpenSource', icon: 'reco-github'}, +] diff --git a/docs/.vuepress/config/zh/series.ts b/docs/.vuepress/config/zh/series.ts new file mode 100644 index 0000000..0eb75e1 --- /dev/null +++ b/docs/.vuepress/config/zh/series.ts @@ -0,0 +1,46 @@ +export const series = { + '/HowToStartOpenSource/': [{ + text: '基础内容', + children: [ + '/HowToStartOpenSource/01-basic-content/01-basic-configuration', + '/HowToStartOpenSource/01-basic-content/02-personal-maintenance-process', + '/HowToStartOpenSource/01-basic-content/03-collaborative-development-process', + '/HowToStartOpenSource/01-basic-content/04-PR-and-issue', + '/HowToStartOpenSource/01-basic-content/05-How-to-configure-a-personal-GitHub-home-page-with-elegance-and-beauty', + '/HowToStartOpenSource/01-basic-content/06-issue-and-PR-template', + ], + }, + { + text: 'GitHub Action', + children: [ + '/HowToStartOpenSource/02-github-actions/01-Automatically-add-TOC-directories-for-README', + '/HowToStartOpenSource/02-github-actions/02-Automatically-add-the-list-of-project-contributors-to-README', + '/HowToStartOpenSource/02-github-actions/03-Automatically-and-elegantly-build-Releases-for-the-project', + '/HowToStartOpenSource/02-github-actions/04-Automatically-get-blog-rss-articles', + '/HowToStartOpenSource/02-github-actions/05-Automatically-build-docker-images-compatible-with-multi-CPU-architecture-and-publish-to-DockerHub', + '/HowToStartOpenSource/02-github-actions/06-Automatically-perform-code-scan-pre-check', + '/HowToStartOpenSource/02-github-actions/07-Automatically-generate-Fans-for-GitHub', + '/HowToStartOpenSource/02-github-actions/08-Automatically-generate-a-personal-star-list-and-classify-it', + '/HowToStartOpenSource/02-github-actions/09-Automatically-get-the-project-current-star-and-fork-to-write-to-Description', + '/HowToStartOpenSource/02-github-actions/10-Automatic-lossless-compression-of-pictures-in-the-warehouse', + '/HowToStartOpenSource/02-github-actions/11-Automatically-detect-problem-links-in-the-project', + '/HowToStartOpenSource/02-github-actions/12-Automatically-build-binary-to-release-of-go-project', + ], + }, + { + text: 'GitHub Tips', + children: [ + '/HowToStartOpenSource/03-github-tips/01-How-to-center-the-table-in-README', + '/HowToStartOpenSource/03-github-tips/02-How-to-configure-multiple-GitHub-accounts-on-one-computer', + '/HowToStartOpenSource/03-github-tips/03-How-to-merge-multiple-submissions-into-one', + '/HowToStartOpenSource/03-github-tips/04-The-skill-of-reading-code-and-running-code', + '/HowToStartOpenSource/03-github-tips/05-Summary-using-GitHub-keyboard-shortcuts', + '/HowToStartOpenSource/03-github-tips/06-Summary-and-arrangement-of-personal-open-source-project-recommendation-platform', + '/HowToStartOpenSource/03-github-tips/07-How-to-bind-a-custom-domain-name-to-GitHub-Pages', + '/HowToStartOpenSource/03-github-tips/08-How-to-deal-with-the-problem-that-file-name-conversion-case-cannot-be-submitted-in-Git', + '/HowToStartOpenSource/03-github-tips/09-How-to-use-pre-commit-to-standardize-coding', + '/HowToStartOpenSource/03-github-tips/10-Use-github-slug-action-to-leak-key-variables-in-the-Github-Action-context', + ], + }, + ], +} diff --git a/docs/.vuepress/data/examples.ts b/docs/.vuepress/data/examples.ts new file mode 100644 index 0000000..eaf6b09 --- /dev/null +++ b/docs/.vuepress/data/examples.ts @@ -0,0 +1,45 @@ +export default [ + { + thumbnail: 'https://oss.bakerchen.top/img/2023-07-18-20-59-20.jpg', + link: 'https://www.bakerchen.top', + avator: 'https://www.bakerchen.top/logo.png', + }, + { + thumbnail: + 'https://user-images.githubusercontent.com/18067907/234058377-28a7e909-ae5c-4e7d-a35b-2968848bef89.png', + link: 'https://www.recoluan.com', + avator: 'https://www.recoluan.com/head.png', + }, + { + thumbnail: + 'https://www.wstee.com/banner.svg', + link: 'https://www.wstee.com', + avator: 'https://www.wstee.com/head.jpg', + }, + { + thumbnail: + 'https://qian-shen.github.io/images/wiki.png', + link: 'https://qian-shen.github.io/', + avator: 'https://qian-shen.github.io/icons/logo.png', + }, + { + thumbnail: "https://typora-licodeao.oss-cn-guangzhou.aliyuncs.com/typoraImg/home.png", + link: "https://www.licodeao.top", + avator: "https://www.licodeao.top/avatar.jpg" + }, + { + thumbnail: "https://github-production-user-asset-6210df.s3.amazonaws.com/75941562/241768717-21953f79-fe88-4dca-bfaf-306d4a8c1dac.png", + link: "https://www.yixiangzhilv.com/", + avator: "https://www.yixiangzhilv.com/head.png" + }, + { + thumbnail: "https://blog.latteandcat.cn/bg.jpg", + link: "https://blog.latteandcat.cn/", + avator: "https://blog.latteandcat.cn/head.png" + }, + { + thumbnail: "https://avatars.githubusercontent.com/u/87223862?v=4", + link: "https://zzh.4everland.app/", + avator: "https://vue3-xiao-admin.4everland.app/static/png/logo-22eeabbe.png" + } +] diff --git a/docs/.vuepress/data/examplesData.js b/docs/.vuepress/data/examplesData.js deleted file mode 100644 index 2b38077..0000000 --- a/docs/.vuepress/data/examplesData.js +++ /dev/null @@ -1,398 +0,0 @@ -export default [ - { - name: '小熊学Java', - desc: '分享Java干货、学习资料等,记录自己的点滴', - link: 'https://javaxiaobear.gitee.io/', - thumbnail: 'https://gitee.com/javaxiaobear/javaXiaobear/raw/master/javaxiaobear.png' - }, - { - name: '午后南杂', - desc: 'Enjoy when you can, and endure when you must.', - link: 'https://www.recoluan.com', - thumbnail: 'https://i.loli.net/2020/04/04/dDLhpXJqvYuROfG.png' - }, - { - name: 'latte and cat', - desc: 'study programs and record life', - link: 'http://blog.smallsunnyfox.com', - thumbnail: 'https://i.loli.net/2020/04/04/lYavGBJpm3scIKH.png' - }, - { - name: 'lookroot的个人空间', - desc: '追求理想与现实的平衡', - link: 'https://www.lookroot.cn/', - thumbnail: '//img.lookroot.cn/blog/202005/25/190857-668213.png' - }, - { - name: '葵花宝典', - desc: '专注前端开发,点一滴都是进步', - link: 'https://hejunlan.gitee.io', - thumbnail: 'https://hejunlan.gitee.io/home.png' - }, - { - name: '星空小屋', - desc: '记录成长,探索未来,持续学习', - link: 'https://www.xk857.com', - thumbnail: 'https://oss.xk857.com/images/20220811/home.png' - }, - { - name: '曦杨小破站', // 站点名称 - desc: '一个前端菜鸡的笔记', // 站点描述 - link: 'https://xiyang6.gitee.io/', // 站点地址 - thumbnail: 'https://s1.ax1x.com/2022/07/26/jzTwvt.png' // 站点图片链接 - }, - { - name: '木木的秘密花园', // 站点名称 - desc: '记录技术点滴,共勉成长!', // 站点描述 - link: 'https://www.pikamumu.top', // 站点地址 - thumbnail: 'https://s2.loli.net/2022/06/22/fhmQcECMqLlHpUT.png' // 站点图片链接 - }, - { - name: 'Torrk’s Blog', - desc: '记录,成为更好的自己。', - link: 'https://conimi.com', - thumbnail: 'https://conimi.com/files/images/i.jpg' - }, - { - name: 'keledd’s blog', - desc: '记录笔记,分享生活', - link: 'https://www.keledd.cn/', - thumbnail: 'https://keledd.cn/keledd.png' - }, - { - name: '山海以南’', // 站点名称 - desc: '不积硅步,无以至千里', // 站点描述 - link: 'https://mu-yan.cn', // 站点地址 - thumbnail: 'https://cdn.jsdelivr.net/gh/Mu-Yan/Mu-Yan.github.io/001.jpg' // 站点图片链接 - }, - { - name: '王世庭的博客', // 站点名称 - desc: '闲人愁多,懒人病多,忙人快活', // 站点描述 - link: 'https://www.wstee.com', // 站点地址 - thumbnail: '/blogImage.png' // 站点图片链接 - }, - { - name: '野猿新知著', // 站点名称 - desc: '享受编程和技术带来的快乐', // 站点描述 - link: 'https://www.duanxiaogang.cn', // 站点地址 - thumbnail: 'https://qiniu.duanxiaogang.cn/home.png'// 站点图片链接 - }, - { - name: '柚子云 ♥️ Blog', // 站点名称 - desc: '一枚程序员的自我修养', // 站点描述 - link: 'https://uzykj.com', // 站点地址 - thumbnail: 'http://file.uzykj.com/uzykj_home.png' // 站点图片链接 - }, - { - name: '默存', - desc: '没有奇迹,只有你努力的轨迹;没有运气,只有你坚持的勇气。', - link: 'https://typ1805.gitee.io/', - thumbnail: 'https://typ1805.gitee.io/tansci.png' - }, - { - name: '尘墨成', - desc: '错把陈醋当成墨,写尽半生纸上酸', - link: 'https://www.dustink.cn', - thumbnail: 'https://www.dustink.cn/blogHome.jpg' - }, - { - name: '花一个无所', // 站点名称 - desc: 'Golang、分布式存储、微服务、基础架构、源码剖析、思想觉悟', // 站点描述 - link: 'http://www.alihanniba.com/', // 站点地址 - thumbnail: 'https://share.alihanniba.com/WechatIMG106.png' // 站点图片链接 - }, - { - name: '半落沙痕', - desc: 'Everything Wins!', - link: 'http://www.dracarys.top', - thumbnail: 'http://img.dracarys.top/avatar.jpg' - }, - { - name: '小紫念沁', - desc: '不积跬步,无以至千里.不积小流,无以成江海', - thumbnail: 'https://anyfork.gitee.io/blog-docs/images/user.jpg', - link: 'https://anyfork.gitee.io/blog-docs/' - }, - { - name: 'Felix’s Blog', - link: 'http://shj4u.work/', - thumbnail: 'http://shj4u.work/imgs/home.png', - desc: 'IT 技术点学习、积累(主 Java)' - }, - { - name: '远近相安', - desc: '过往的,都是我勇气,和继续的源泉', - link: 'https://lazerching.github.io/SamerBlog', - thumbnail: 'https://raw.githubusercontent.com/LazerChing/SamerBlog/master/thumbnail.png' - }, - { - name: '孔德超', // 站点名称 - desc: '个人博客', // 站点描述 - link: 'https://resume.yourtools.icu/', // 站点地址 - thumbnail: '/blogImages/午后南杂.png' // 站点图片链接 - }, - { - name: '攀登者', // 站点名称 - desc: 'a small developer.', // 站点描述 - link: 'https://blog.wangscaler.com/', // 站点地址 - thumbnail: '/logo.png' // 站点图片链接 - }, - { - name: '西瓜皮儿', - desc: 'enjoy your grow up!', - link: 'https://coderhdy.com/', - thumbnail: 'https://coderhdy.com/assets/img/snapshot.png' - }, - { - name: 'ProChick的小站', - desc: '奋斗从未停止,前进永无止境!', - link: 'https://www.prochick.top', - thumbnail: 'https://www.prochick.top/images/logo.png' - }, - { - name: 'ImCaO’s Blog', - desc: '当我下定决心奔向你时,不要推开我', - link: 'https://www.imcao.c', - thumbnail: 'https://imcao.gitee.io/photo/home.jpe' - }, - { - name: '会飞的鱼在线文档', - desc: '世界从不平等,你有多努力,就有多特殊。', - link: 'http://docs.sidama.work', - thumbnail: 'https://img-blog.csdnimg.cn/f102b83ccff54a82af6e4346830e8d0a.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBAcXFfMzg2NjA1MDky,size_20,color_FFFFFF,t_70,g_se,x_16' - }, - { - name: 'Wallace’s Blog', - desc: '记录个人修行中的点滴', - link: 'https://wallacexu.site', - thumbnail: '/appendix/thumbnail.png' - }, - { - name: 'Kim’s Blog', - desc: '做技术与艺术的创新者', - link: 'https://kimyang.cn/', - thumbnail: 'https://kimyang.cn/bg.jpg' - }, - { - name: '韦世东的技术专栏', - desc: '专注于体系化 IT 技术知识分享,内容涵盖Python|Golang|Rust|Kubernetes|高性能|分布式|爬虫|架构|逆向', - link: 'https://www.weishidong.com/', // 站点地址 - thumbnail: 'https://img.weishidong.com/20210313125014.png' // 站点图片链接 - }, - { - name: '地球反三体组织', // 站点名称 - desc: '原力与你同在', // 站点描述 - link: 'http://k-wei.gitee.io/', // 站点地址 - thumbnail: '//image.woai996.com/picGo/bg-one.png' // 站点图片链接 - }, - { - name: '饭团也有春天', // 站点名称 - desc: '没有梦想,也能远方', // 站点描述 - link: 'http://www.zpzpup.com/blog/', // 站点地址 - thumbnail: 'http://www.zpzpup.com/assets/image/blog1.png' // 站点图片链接 - }, - { - name: '小诺', - desc: '可能是支持数据库最全面的低代码快速开发平台', - link: 'https://doc.xiaonuo.vip/', - thumbnail: "https://pan.xiaonuo.vip/?explorer/share/file&hash=5671wIIFKjMFfDflnX1eE2tn15OW6SvsBQz00bqzMPgsns19fPNRJFQ&name=xiaonuo_vue.png", - }, - { - name: '檐上有月', // 站点名称 - desc: 'alk is cheap,show me the code.', // 站点描述 - link: 'https://rodrick.cn/', // 站点地址 - thumbnail: 'https://gitee.com/rodrick278/blog/raw/master/docs/.vuepress/public/titlebg.webp' // 站点图片链接 - }, - { - name: '幸运抽奖插件 (大转盘 / 九宫格)', - desc: '🎉一个支持 vue2 / vue3 的(大转盘 / 九宫格)抽奖插件,🎨奖品 / 文字 / 图片 / 颜色 / 按钮均可配置,🏅支持同步 / 异步抽奖,概率前 / 后端可控', - link: 'https://100px.net', - thumbnail: 'https://100px.net/logo.png' - }, - { - name: 'Mr.Mao’s blog', - desc: 'For man is man and master of his fate.', - link: 'https://tuimao233.gitee.io/mao-blog/', - thumbnail: 'https://tuimao233.gitee.io/mao-blog/mao-blog/bg.jpg' - }, - { - name: '经过', - desc: '以梦为马,明日天涯', - link: 'https://www.chenzqi.cn/', - thumbnail: 'https://www.chenzqi.cn/logo.png' - }, - { - name: '极客小祥', - desc: '永远相信美好的事情即将发生', - link: 'https://jtxyh.top/', - thumbnail: 'https://jtxyh.top/logo.png' - }, - { - name: 'GolangRoadmap.com', - desc: 'Gopher一站式学习平台。', - link: 'https://www.golangroadmap.com/', - thumbnail: 'https://www.golangroadmap.com/img/thumbnail.png' - }, - { - name: 'zealsay说你想说', - desc: '大道至简,追求优雅代码永无止境。', - link: 'https://www.zealsay.com', - thumbnail: 'https://pan.zealsay.com/blog/20200819192408.jpg' - }, - { - name: '后来的我们', - desc: 'It takes two to tango.', - link: 'https://zyj_yida.gitee.io/', - thumbnail: 'https://zyj_yida.gitee.io/source/img/indexbg/5.jpg?timestamp=1603386765821' - }, - { - name: '鹅不食草', - desc: '就老去吧,孤独别醒来', - link: 'https://haveyuan.github.io', - thumbnail: 'https://haveyuan.github.io/index_bg.webp' - }, - { - name: 'QiJieH\'s Blog', - desc: '于朝阳升起处,我将踏上旅程', - link: 'https://qijieh.gitee.io/blog/', - thumbnail: 'https://gitee.com/QiJieH/blog-image-bed/raw/master//20200809182218.png' - }, - { - name: '互勉之', - desc: '跬步千里,积微成著', - link: 'https://zihonghuang.gitee.io', - thumbnail: 'https://zihonghuang.gitee.io/image/bg1.jpg' - }, - { - name: 'lin', - desc: '不为模糊不清的未来担忧,只为清清楚楚的现在努力', - link: 'https://www.xulin.vip/', // 站点地址 - thumbnail: 'https://www.xulin.vip/bg.jpg' // 站点图片链接 - }, - { - name: '君陌离的博客', - desc: 'STUDY PROGRAMS AND RECORD LIFE', - link: 'https://songjun520.cn', - thumbnail: 'https://songjun520.cn/bg.png' - }, - { - name: 'w晚风阅览馆', - link: 'http://bk.xiat123.cn', - thumbnail: 'http://bk.xiat123.cn/head.jpg', - desc: '流年以笑掷,未来诚可期!' - }, - { - name: '叫我詹躲躲', - desc: '岂能尽如人意,但求无愧于心', - link: 'https://zhanhongzhu.top/', - thumbnail: 'https://dcdn.it120.cc/2020/07/05/a55d7d9a-b7e1-4391-a6ad-040360f7de75.png' - }, - { - name: 'stay true to the mission', - desc: '人生在勤,不索何获。技术笔记,好学不厌。', - link: 'https://www.weicker.cn/', - thumbnail: 'https://www.weicker.cn/banners.png' - }, - { - name: 'CHANX\'s Blog', - desc: '想法 + 实践 = BUG', - link: 'https://www.chanx.tech/', - thumbnail: 'https://www.chanx.tech/thumbnail.png' - }, - { - name: '倚天丶惊鸿的博客', - desc: '分享Web前端开发知识,在这记录了我成长的脚步', - link: 'https://blog.yitian2019.cn/', - thumbnail: 'https://oss.yitian2019.cn/img/blog.png' - }, - { - name: '白日醒梦', - desc: 'Simple Life.', - link: 'https://saszr.gitee.io/blog/', - thumbnail: 'https://pic.saszr.xyz/qiniu/20200525122314.png' - }, - { - name: 'congco', - desc: '得道者多助,失道者寡助', - link: 'https://snowyan.gitee.io/', - thumbnail: 'https://s1.ax1x.com/2020/05/16/Y6BMHs.png' - }, - { - name: 'SUMMER-1874', - desc: '当我沉默的时候,我觉得很充实,当我开口说话,就感到了空虚。', - link: 'http://summer1874.top', - thumbnail: 'https://pic.downk.cc/item/5eb8fb6ac2a9a83be5e9d6f2.png' - }, - { - name: '404 NOT FOUND', - desc: '前端杂货铺', - link: 'https://wang.icey.cc/', - thumbnail: 'https://i.loli.net/2020/04/04/zByhlLKiQZgcCnU.png' - }, - { - name: '凝弧', - desc: '理解了目标,方向自然就出现了', - link: 'https://callsoul.cn/', - thumbnail: 'https://i.loli.net/2020/04/04/4sxpmhZTula3D7t.png' - }, - { - name: 'Leecason', - desc: '若我所见不同,独守一角青空', - link: 'https://leecason.github.io', - thumbnail: 'https://i.loli.net/2020/04/04/utP65sSnzULdGCb.png' - }, - { - name: '平凡的你我', - desc: '理想成为大牛的小陈同学', - link: 'https://reinness.com/', - thumbnail: 'https://i.loli.net/2020/04/04/URgkBnmDcbL6XxT.png' - }, - { - name: '山水有轻音', - desc: '开启旅行笔记', - link: 'http://blod.wxinxianyun.com/', - thumbnail: 'https://i.loli.net/2020/04/04/ebr4quEHgyC9n5W.png' - }, - { - name: 'Black House', - desc: '代码千万行, 注释第一行, 编码不规范, 同事两行泪.', - link: 'https://dong4j.github.io/', - thumbnail: 'https://i.loli.net/2020/04/04/PNUm1zfVCLF3eIb.png' - }, - { - name: '学海无涯', - desc: '暂无', - link: 'https://www.xuminhua.com/', - thumbnail: 'https://i.loli.net/2020/04/04/Nh9u5Bm1E8wniVz.png' - }, - { - name: 'znote', - desc: '荷尽已无擎雨盖,菊残犹有傲霜枝。', - link: 'https://zpj80231.github.io/znote/', - thumbnail: 'https://i.loli.net/2020/04/04/2Fq8jYSb6EkUXeH.png' - }, - { - name: 'Life\'s Moment', - desc: '记录生活,分享感动', - link: 'https://ty-peng.gitee.io/', - thumbnail: 'https://i.loli.net/2020/04/04/srGnE4HXAIfPJ1N.png' - }, - { - name: '俊逸的博客', - desc: '一枚喜欢研究新技术的程序猿,主职Java、副职前端,欢迎访问', - link: 'https://lijunyi2.github.io/blog/', - thumbnail: 'https://lijunyi2.github.io/blog/logo.png' - }, - { - name: 'jokervTv 爬坑历程', - desc: '大气科学 爬坑历程', - link: 'https://jokervtv.top/blog/', - thumbnail: 'https://i.loli.net/2020/04/04/w2dRfYat3ybOj9G.png' - }, - { - name: '青灯有味', - desc: '一款简洁易懂算法博客 & 文档抠细节 & 主题', - link: 'https://zscnb.gitee.io', - thumbnail: 'https://zscnb.gitee.io/bg.png' - } -] diff --git a/docs/.vuepress/data/pluginsData.js b/docs/.vuepress/data/pluginsData.js deleted file mode 100644 index f612022..0000000 --- a/docs/.vuepress/data/pluginsData.js +++ /dev/null @@ -1,139 +0,0 @@ -export default [ - { - name: 'vuepress-plugin-sponsor', - desc: '打赏插件', - user: 'yokefellow', - repo: 'vuepress-plugin-sponsor', - feature: 'feature', - scenes: 'independent' - }, - { - name: '@vuepress-reco/back-to-top', - desc: '回到顶部。', - user: 'vuepress-reco', - repo: 'vuepress-plugin-back-to-top', - feature: 'feature', - scenes: 'independent' - }, - { - name: '@vuepress-reco/pagation', - desc: '分页。', - user: 'vuepress-reco', - repo: 'vuepress-plugin-pagation', - feature: 'feature', - scenes: 'develop' - }, - { - name: '@vuepress-reco/loading-page', - desc: '加载 loading 页。', - user: 'vuepress-reco', - repo: 'vuepress-plugin-loading-page', - feature: 'style', - scenes: 'develop' - }, - { - name: '@vuepress-reco/kan-ban-niang', - desc: '看板娘 live2d 动画。', - user: 'vuepress-reco', - repo: 'vuepress-plugin-kan-ban-niang', - feature: 'style', - scenes: 'develop' - }, - { - name: '@vuepress-reco/comments', - desc: '评论功能,集成 valine 和 vssue。', - user: 'vuepress-reco', - repo: 'vuepress-plugin-comments', - feature: 'feature', - scenes: 'develop' - }, - { - name: '@vuepress-reco/extract-code', - desc: '功能代码展示插件,展示多种语言于一窗,增加易读性。', - user: 'vuepress-reco', - repo: 'vuepress-plugin-extract-code', - feature: 'feature', - scenes: 'develop' - }, - { - name: '@vuepress-reco/bgm-player', - desc: '一款简洁的音乐播放器。', - user: 'vuepress-reco', - repo: 'vuepress-plugin-bgm-player', - feature: 'feature', - scenes: 'independent' - }, - { - name: '@vuepress-reco/rss', - desc: '生成 RSS 页面。', - user: 'vuepress-reco', - repo: 'vuepress-plugin-rss', - feature: 'feature', - scenes: 'independent' - }, - { - //使用说明网址见:https://zpj80231.gitee.io/znote/views/front-end/vuepress-plugin-boxx.html - name: 'vuepress-plugin-boxx', - desc: '为博客文章自动随机添加名人名言或其他,可自定义样式和内容。', - user: 'zpj80231', - repo: 'vuepress-plugin-boxx', - feature: 'feature', - scenes: 'independent' - }, - { - name: 'go-top', - desc: '回到顶部。', - user: 'SigureMo', - repo: 'vuepress-plugin-go-top', - feature: 'feature', - scenes: 'independent' - }, - { - name: 'ribbon', - desc: '在您的 Vuepress 中添加美丽的丝带!', - user: 'SigureMo', - repo: 'vuepress-plugin-ribbon', - feature: 'style', - scenes: 'independent' - }, - { - name: 'cursor-effects', - desc: '在您的 vuepress 中添加可爱的光标效果!', - user: 'SigureMo', - repo: 'vuepress-plugin-cursor-effects', - feature: 'style', - scenes: 'independent' - }, - { - name: 'dynamic-title', - desc: '在您的 vuepress 中添加动态标题!', - user: 'SigureMo', - repo: 'vuepress-plugin-dynamic-title', - feature: 'style', - scenes: 'independent' - }, - { - name: 'dynamic-title', - desc: '流程图。', - user: 'ulivz', - repo: 'vuepress-plugin-flowchart', - feature: 'feature', - scenes: 'independent' - }, - { - name: '@vuepress/plugin-medium-zoom', - desc: '图片放大。', - user: 'vuejs', - repo: 'vuepress/tree/master/packages/@vuepress/plugin-medium-zoom', - feature: 'feature', - scenes: 'independent' - }, - { - name: 'sitemap', - desc: 'Sitemap 生成器。', - user: 'ekoeryanto', - repo: 'vuepress-plugin-sitemap', - feature: 'feature', - scenes: 'independent' - } -] \ No newline at end of file diff --git a/docs/.vuepress/components/images/bg.svg b/docs/.vuepress/public/bg.svg similarity index 82% rename from docs/.vuepress/components/images/bg.svg rename to docs/.vuepress/public/bg.svg index f755c29..262b6ae 100644 --- a/docs/.vuepress/components/images/bg.svg +++ b/docs/.vuepress/public/bg.svg @@ -1,4 +1,4 @@ - - + @@ -15,7 +15,7 @@ - + @@ -32,4 +32,8 @@ - \ No newline at end of file + + + + + diff --git a/docs/.vuepress/public/data/docs-scraper-config.json b/docs/.vuepress/public/data/docs-scraper-config.json deleted file mode 100644 index e6b06b9..0000000 --- a/docs/.vuepress/public/data/docs-scraper-config.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "index_uid": "howtoStartOpenSource", - "sitemap_urls": ["https://eryajf.github.io/HowToStartOpenSource/sitemap.xml"], - "start_urls": ["https://eryajf.github.io/HowToStartOpenSource/"], - "stop_urls": [ - "https://eryajf.github.io/HowToStartOpenSource/en/", - "https://eryajf.github.io/HowToStartOpenSource/tag/", - "https://eryajf.github.io/HowToStartOpenSource/timeline/", - "https://eryajf.github.io/HowToStartOpenSource/categories/" - ], - "selectors": { - "lvl0": { - "selector": "h1", - "global": true, - "default_value": "Documentation" - }, - "lvl1": ".theme-reco-content h2", - "lvl2": ".theme-reco-content h3", - "lvl3": ".theme-reco-content h4", - "lvl4": ".theme-reco-content h5", - "lvl5": ".theme-reco-content h6", - "text": ".theme-reco-content p, .theme-reco-content li" - }, - "strip_chars": " .,;:#", - "scrap_start_urls": true, - "selectors_exclude": ["iframe", ".katex-block", ".md-flowchart", ".md-mermaid", ".md-presentation.reveal.reveal-viewport", ".line-numbers-mode", ".code-group", ".footnotes", "footer.page-meta", ".page-nav", ".comments-wrapper"] -} \ No newline at end of file diff --git a/docs/.vuepress/public/favicon1.ico b/docs/.vuepress/public/favicon1.ico deleted file mode 100644 index c3a0b3c..0000000 Binary files a/docs/.vuepress/public/favicon1.ico and /dev/null differ diff --git a/docs/.vuepress/public/manifest.json b/docs/.vuepress/public/manifest.json deleted file mode 100644 index 972a205..0000000 --- a/docs/.vuepress/public/manifest.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "name": "HowToStartOpenSource", - "short_name": "HowToStartOpenSource", - "icons": [ - { - "src": "/logo.png", - "sizes": "192x192", - "type": "image/png" - }, - { - "src": "/logo.png", - "sizes": "512x512", - "type": "image/png" - } - ], - "start_url": "/index.html", - "display": "standalone", - "background_color": "#fff", - "theme_color": "#42b983" -} \ No newline at end of file diff --git a/docs/.vuepress/styles/index.styl b/docs/.vuepress/styles/index.styl deleted file mode 100644 index 19eb0f2..0000000 --- a/docs/.vuepress/styles/index.styl +++ /dev/null @@ -1,16 +0,0 @@ -// html, body { -// font-family: Comic Sans MS, "Comic Sans MS", -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif !important; -// } - -.nav-links .repo-link { - display: none -} - -// 禁用首页的content展示 -.md-content-wrapper { - display: none -} -// 禁用底部footer的展示 -.footer-wrapper { - display: none -} diff --git a/docs/.vuepress/styles/palette.styl b/docs/.vuepress/styles/palette.styl deleted file mode 100644 index 6f723ce..0000000 --- a/docs/.vuepress/styles/palette.styl +++ /dev/null @@ -1,6 +0,0 @@ -$accentColor = #3eaf7c - -// meilisearch 样式自定义 -$accentDarkColor = #FF85BF -$textDarkColor = #FAFBFE -$borderDarkColor = #352A43 \ No newline at end of file diff --git a/docs/views/01-basic-content/01-basic-configuration.md b/docs/HowToStartOpenSource/01-basic-content/01-basic-configuration.md similarity index 100% rename from docs/views/01-basic-content/01-basic-configuration.md rename to docs/HowToStartOpenSource/01-basic-content/01-basic-configuration.md diff --git a/docs/views/01-basic-content/02-personal-maintenance-process.md b/docs/HowToStartOpenSource/01-basic-content/02-personal-maintenance-process.md similarity index 100% rename from docs/views/01-basic-content/02-personal-maintenance-process.md rename to docs/HowToStartOpenSource/01-basic-content/02-personal-maintenance-process.md diff --git a/docs/views/01-basic-content/03-collaborative-development-process.md b/docs/HowToStartOpenSource/01-basic-content/03-collaborative-development-process.md similarity index 100% rename from docs/views/01-basic-content/03-collaborative-development-process.md rename to docs/HowToStartOpenSource/01-basic-content/03-collaborative-development-process.md diff --git a/docs/views/01-basic-content/04-PR-and-issue.md b/docs/HowToStartOpenSource/01-basic-content/04-PR-and-issue.md similarity index 100% rename from docs/views/01-basic-content/04-PR-and-issue.md rename to docs/HowToStartOpenSource/01-basic-content/04-PR-and-issue.md diff --git a/docs/views/01-basic-content/05-How-to-configure-a-personal-GitHub-home-page-with-elegance-and-beauty.md b/docs/HowToStartOpenSource/01-basic-content/05-How-to-configure-a-personal-GitHub-home-page-with-elegance-and-beauty.md similarity index 100% rename from docs/views/01-basic-content/05-How-to-configure-a-personal-GitHub-home-page-with-elegance-and-beauty.md rename to docs/HowToStartOpenSource/01-basic-content/05-How-to-configure-a-personal-GitHub-home-page-with-elegance-and-beauty.md diff --git a/docs/views/01-basic-content/06-issue-and-PR-template.md b/docs/HowToStartOpenSource/01-basic-content/06-issue-and-PR-template.md similarity index 100% rename from docs/views/01-basic-content/06-issue-and-PR-template.md rename to docs/HowToStartOpenSource/01-basic-content/06-issue-and-PR-template.md diff --git a/docs/HowToStartOpenSource/02-github-actions/01-Automatically-add-TOC-directories-for-README.md b/docs/HowToStartOpenSource/02-github-actions/01-Automatically-add-TOC-directories-for-README.md new file mode 100644 index 0000000..3ad5585 --- /dev/null +++ b/docs/HowToStartOpenSource/02-github-actions/01-Automatically-add-TOC-directories-for-README.md @@ -0,0 +1,50 @@ +--- +title: 自动为README添加TOC目录 +date: 2022-07-18 17:23:23 +--- + +GitHub的Markdown目前不支持直接`[TOC]`渲染文章的目录,有些README则需要这样的效果,可以借助外部工具进行生成,也可以借助 `GitHub Actions` 自动生成,本文就介绍这种方式。 + +所用Actions:[TOC Generator](https://github.com/marketplace/actions/toc-generator) + +使用配置其实非常简单,基本上阅读完官方介绍文档就可以上手使用了,这里说一两个需要注意的地方。 + +首先需要在将要生成目录的文件内,指定目录生成位置,e.g. `README.md`,在要生成的地方添加如下内容: + +``` + + +``` + +然后添加Actions配置文件,e.g. `.github/workflows/toc.yml`: + +```yml +on: push +name: TOC Generator +jobs: + generateTOC: + name: TOC Generator + runs-on: ubuntu-latest + steps: + - uses: technote-space/toc-generator@v4 +``` + +接着需要调整下项目的Actions权限,在GitHub上点击`settings`--> `actions` --> `General` --> `Workflow permissions` --> 选择 `Read and write permissions`。 + +![image_20220718_172340](https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20220718_172340.png) + +配置调整完成之后,就可以push项目看效果了,当然这里也可以通过GitHub_Token的方式认证,就不赘述了。 + +效果呈现如下: + +![image_20220719_110310](https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20220719_110310.png) + +`配置列表:`[点我查看](https://github.com/marketplace/actions/toc-generator#options) + +可根据自己的实际需求以及情况进行配置! + +## 另外 + +后来在一个地方学到了一招,原来GitHub针对Markdown文件已经默认支持了目录的方式,并且还支持搜索,如下: + +![image_20220719_110613](https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20220719_110613.png) \ No newline at end of file diff --git a/docs/views/02-github-actions/02-Automatically-add-the-list-of-project-contributors-to-README.md b/docs/HowToStartOpenSource/02-github-actions/02-Automatically-add-the-list-of-project-contributors-to-README.md similarity index 100% rename from docs/views/02-github-actions/02-Automatically-add-the-list-of-project-contributors-to-README.md rename to docs/HowToStartOpenSource/02-github-actions/02-Automatically-add-the-list-of-project-contributors-to-README.md diff --git a/docs/views/02-github-actions/03-Automatically-and-elegantly-build-Releases-for-the-project.md b/docs/HowToStartOpenSource/02-github-actions/03-Automatically-and-elegantly-build-Releases-for-the-project.md similarity index 100% rename from docs/views/02-github-actions/03-Automatically-and-elegantly-build-Releases-for-the-project.md rename to docs/HowToStartOpenSource/02-github-actions/03-Automatically-and-elegantly-build-Releases-for-the-project.md diff --git a/docs/views/02-github-actions/04-Automatically-get-blog-rss-articles.md b/docs/HowToStartOpenSource/02-github-actions/04-Automatically-get-blog-rss-articles.md similarity index 100% rename from docs/views/02-github-actions/04-Automatically-get-blog-rss-articles.md rename to docs/HowToStartOpenSource/02-github-actions/04-Automatically-get-blog-rss-articles.md diff --git a/docs/views/02-github-actions/05-Automatically-build-docker-images-compatible-with-multi-CPU-architecture-and-publish-to-DockerHub.md b/docs/HowToStartOpenSource/02-github-actions/05-Automatically-build-docker-images-compatible-with-multi-CPU-architecture-and-publish-to-DockerHub.md similarity index 100% rename from docs/views/02-github-actions/05-Automatically-build-docker-images-compatible-with-multi-CPU-architecture-and-publish-to-DockerHub.md rename to docs/HowToStartOpenSource/02-github-actions/05-Automatically-build-docker-images-compatible-with-multi-CPU-architecture-and-publish-to-DockerHub.md diff --git a/docs/views/02-github-actions/06-Automatically-perform-code-scan-pre-check.md b/docs/HowToStartOpenSource/02-github-actions/06-Automatically-perform-code-scan-pre-check.md similarity index 100% rename from docs/views/02-github-actions/06-Automatically-perform-code-scan-pre-check.md rename to docs/HowToStartOpenSource/02-github-actions/06-Automatically-perform-code-scan-pre-check.md diff --git a/docs/views/02-github-actions/07-Automatically-generate-Fans-for-GitHub.md b/docs/HowToStartOpenSource/02-github-actions/07-Automatically-generate-Fans-for-GitHub.md similarity index 100% rename from docs/views/02-github-actions/07-Automatically-generate-Fans-for-GitHub.md rename to docs/HowToStartOpenSource/02-github-actions/07-Automatically-generate-Fans-for-GitHub.md diff --git a/docs/views/02-github-actions/08-Automatically-generate-a-personal-star-list-and-classify-it.md b/docs/HowToStartOpenSource/02-github-actions/08-Automatically-generate-a-personal-star-list-and-classify-it.md similarity index 100% rename from docs/views/02-github-actions/08-Automatically-generate-a-personal-star-list-and-classify-it.md rename to docs/HowToStartOpenSource/02-github-actions/08-Automatically-generate-a-personal-star-list-and-classify-it.md diff --git a/docs/views/02-github-actions/09-Automatically-get-the-project-current-star-and-fork-to-write-to-Description.md b/docs/HowToStartOpenSource/02-github-actions/09-Automatically-get-the-project-current-star-and-fork-to-write-to-Description.md similarity index 100% rename from docs/views/02-github-actions/09-Automatically-get-the-project-current-star-and-fork-to-write-to-Description.md rename to docs/HowToStartOpenSource/02-github-actions/09-Automatically-get-the-project-current-star-and-fork-to-write-to-Description.md diff --git a/docs/views/02-github-actions/10-Automatic-lossless-compression-of-pictures-in-the-warehouse.md b/docs/HowToStartOpenSource/02-github-actions/10-Automatic-lossless-compression-of-pictures-in-the-warehouse.md similarity index 100% rename from docs/views/02-github-actions/10-Automatic-lossless-compression-of-pictures-in-the-warehouse.md rename to docs/HowToStartOpenSource/02-github-actions/10-Automatic-lossless-compression-of-pictures-in-the-warehouse.md diff --git a/docs/views/02-github-actions/11-Automatically-detect-problem-links-in-the-project.md b/docs/HowToStartOpenSource/02-github-actions/11-Automatically-detect-problem-links-in-the-project.md similarity index 100% rename from docs/views/02-github-actions/11-Automatically-detect-problem-links-in-the-project.md rename to docs/HowToStartOpenSource/02-github-actions/11-Automatically-detect-problem-links-in-the-project.md diff --git a/docs/views/02-github-actions/12-Automatically-build-binary-to-release-of-go-project.md b/docs/HowToStartOpenSource/02-github-actions/12-Automatically-build-binary-to-release-of-go-project.md similarity index 100% rename from docs/views/02-github-actions/12-Automatically-build-binary-to-release-of-go-project.md rename to docs/HowToStartOpenSource/02-github-actions/12-Automatically-build-binary-to-release-of-go-project.md diff --git a/docs/views/03-github-tips/01-How-to-center-the-table-in-README.md b/docs/HowToStartOpenSource/03-github-tips/01-How-to-center-the-table-in-README.md similarity index 100% rename from docs/views/03-github-tips/01-How-to-center-the-table-in-README.md rename to docs/HowToStartOpenSource/03-github-tips/01-How-to-center-the-table-in-README.md diff --git a/docs/views/03-github-tips/02-How-to-configure-multiple-GitHub-accounts-on-one-computer.md b/docs/HowToStartOpenSource/03-github-tips/02-How-to-configure-multiple-GitHub-accounts-on-one-computer.md similarity index 100% rename from docs/views/03-github-tips/02-How-to-configure-multiple-GitHub-accounts-on-one-computer.md rename to docs/HowToStartOpenSource/03-github-tips/02-How-to-configure-multiple-GitHub-accounts-on-one-computer.md diff --git a/docs/views/03-github-tips/03-How-to-merge-multiple-submissions-into-one.md b/docs/HowToStartOpenSource/03-github-tips/03-How-to-merge-multiple-submissions-into-one.md similarity index 100% rename from docs/views/03-github-tips/03-How-to-merge-multiple-submissions-into-one.md rename to docs/HowToStartOpenSource/03-github-tips/03-How-to-merge-multiple-submissions-into-one.md diff --git a/docs/views/03-github-tips/04-The-skill-of-reading-code-and-running-code.md b/docs/HowToStartOpenSource/03-github-tips/04-The-skill-of-reading-code-and-running-code.md similarity index 100% rename from docs/views/03-github-tips/04-The-skill-of-reading-code-and-running-code.md rename to docs/HowToStartOpenSource/03-github-tips/04-The-skill-of-reading-code-and-running-code.md diff --git a/docs/views/03-github-tips/05-Summary-using-GitHub-keyboard-shortcuts.md b/docs/HowToStartOpenSource/03-github-tips/05-Summary-using-GitHub-keyboard-shortcuts.md similarity index 100% rename from docs/views/03-github-tips/05-Summary-using-GitHub-keyboard-shortcuts.md rename to docs/HowToStartOpenSource/03-github-tips/05-Summary-using-GitHub-keyboard-shortcuts.md diff --git a/docs/en/views/03-github-tips/06-Summary-and-arrangement-of-personal-open-source-project-recommendation-platform.md b/docs/HowToStartOpenSource/03-github-tips/06-Summary-and-arrangement-of-personal-open-source-project-recommendation-platform.md similarity index 100% rename from docs/en/views/03-github-tips/06-Summary-and-arrangement-of-personal-open-source-project-recommendation-platform.md rename to docs/HowToStartOpenSource/03-github-tips/06-Summary-and-arrangement-of-personal-open-source-project-recommendation-platform.md diff --git a/docs/views/03-github-tips/07-How-to-bind-a-custom-domain-name-to-GitHub-Pages.md b/docs/HowToStartOpenSource/03-github-tips/07-How-to-bind-a-custom-domain-name-to-GitHub-Pages.md similarity index 100% rename from docs/views/03-github-tips/07-How-to-bind-a-custom-domain-name-to-GitHub-Pages.md rename to docs/HowToStartOpenSource/03-github-tips/07-How-to-bind-a-custom-domain-name-to-GitHub-Pages.md diff --git a/docs/views/03-github-tips/08-How-to-deal-with-the-problem-that-file-name-conversion-case-cannot-be-submitted-in-Git.md b/docs/HowToStartOpenSource/03-github-tips/08-How-to-deal-with-the-problem-that-file-name-conversion-case-cannot-be-submitted-in-Git.md similarity index 100% rename from docs/views/03-github-tips/08-How-to-deal-with-the-problem-that-file-name-conversion-case-cannot-be-submitted-in-Git.md rename to docs/HowToStartOpenSource/03-github-tips/08-How-to-deal-with-the-problem-that-file-name-conversion-case-cannot-be-submitted-in-Git.md diff --git a/docs/views/03-github-tips/09-How-to-use-pre-commit-to-standardize-coding.md b/docs/HowToStartOpenSource/03-github-tips/09-How-to-use-pre-commit-to-standardize-coding.md similarity index 100% rename from docs/views/03-github-tips/09-How-to-use-pre-commit-to-standardize-coding.md rename to docs/HowToStartOpenSource/03-github-tips/09-How-to-use-pre-commit-to-standardize-coding.md diff --git a/docs/views/03-github-tips/10-Use-github-slug-action-to-leak-key-variables-in-the-Github-Action-context.md b/docs/HowToStartOpenSource/03-github-tips/10-Use-github-slug-action-to-leak-key-variables-in-the-Github-Action-context.md similarity index 100% rename from docs/views/03-github-tips/10-Use-github-slug-action-to-leak-key-variables-in-the-Github-Action-context.md rename to docs/HowToStartOpenSource/03-github-tips/10-Use-github-slug-action-to-leak-key-variables-in-the-Github-Action-context.md diff --git a/docs/views/other/myopensource.md b/docs/HowToStartOpenSource/other/myopensource.md similarity index 83% rename from docs/views/other/myopensource.md rename to docs/HowToStartOpenSource/other/myopensource.md index 1f938c5..97175f5 100644 --- a/docs/views/other/myopensource.md +++ b/docs/HowToStartOpenSource/other/myopensource.md @@ -4,26 +4,12 @@ date: 2022-07-24 16:04:55 --- -## 开源名片 - -::: center -[![eryajf’s GitHub image](https://crd.so/i/eryajf?dark&removeLink)](https://github.com/eryajf) -::: - ## 提交历史 ::: center -[![](https://raw.githubusercontent.com/eryajf/eryajf/master/assets/github-contribution-grid-snake.svg)](https://github.com/eryajf) - [![](https://raw.githubusercontent.com/eryajf/eryajf/master/profile-3d-contrib/profile-night-rainbow.svg)](https://raw.githubusercontent.com/eryajf/eryajf/master/profile-3d-contrib/profile-night-rainbow.svg) ::: -## 状态总览 - -::: center -[![二丫讲梵's github stats](https://github-readme-stats.vercel.app/api?username=eryajf&hide_title=false&hide_border=true&show_icons=true&include_all_commits=true&line_height=20&bg_color=0,EC6C6C,FFD479,FFFC79,73FA79&theme=graywhite&locale=cn)](https://github-readme-stats.vercel.app/api?username=eryajf&hide_title=false&hide_border=true&show_icons=true&include_all_commits=true&line_height=20&bg_color=0,EC6C6C,FFD479,FFFC79,73FA79&theme=graywhite&locale=cn) -::: - ## 开源项目 如果你觉得项目不错,欢迎来个🤩 Star 🤩 @@ -55,3 +41,10 @@ date: 2022-07-24 16:04:55 | [ldapool](https://github.com/eryajf/ldapool) | ![](https://img.shields.io/github/stars/eryajf/ldapool?color=f2f08d&logo=Undertale&logoColor=eb4630) | ![](https://img.shields.io/github/watchers/eryajf/ldapool?color=6ed17a&logo=1001Tracklists) | ![](https://img.shields.io/github/forks/eryajf/ldapool?color=ba86eb&logo=Handshake&logoColor=ea6aa6) | go-ldap库的连接池实现 | | [gojenkins](https://github.com/eryajf/gojenkins) | ![](https://img.shields.io/github/stars/eryajf/gojenkins?color=f2f08d&logo=Undertale&logoColor=eb4630) | ![](https://img.shields.io/github/watchers/eryajf/gojenkins?color=6ed17a&logo=1001Tracklists) | ![](https://img.shields.io/github/forks/eryajf/gojenkins?color=ba86eb&logo=Handshake&logoColor=ea6aa6) | fork自gojenkins,增加了很多功能 | | [chatgpt-dingtalk](https://github.com/eryajf/chatgpt-dingtalk) | ![](https://img.shields.io/github/stars/eryajf/chatgpt-dingtalk?color=f2f08d&logo=Undertale&logoColor=eb4630) | ![](https://img.shields.io/github/watchers/eryajf/chatgpt-dingtalk?color=6ed17a&logo=1001Tracklists) | ![](https://img.shields.io/github/forks/eryajf/chatgpt-dingtalk?color=ba86eb&logo=Handshake&logoColor=ea6aa6) | chatGPT机器人在钉钉群聊中交互 | +| [emotion_generate](https://github.com/eryajf/emotion_generate) | ![](https://img.shields.io/github/stars/eryajf/emotion_generate?color=f2f08d&logo=Undertale&logoColor=eb4630) | ![](https://img.shields.io/github/forks/eryajf/emotion_generate?color=ba86eb&logo=Handshake&logoColor=ea6aa6) | Artalk评论系统的表情包 | +| [awesome-chatgpt-answer](https://github.com/eryajf/awesome-chatgpt-answer) | ![](https://img.shields.io/github/stars/eryajf/awesome-chatgpt-answer?color=f2f08d&logo=Undertale&logoColor=eb4630) | ![](https://img.shields.io/github/forks/eryajf/awesome-chatgpt-answer?color=ba86eb&logo=Handshake&logoColor=ea6aa6) | 🙋 问得好,🗣 答得妙。 | +| [eryajf-dockerfile](https://github.com/eryajf/eryajf-dockerfile) | ![](https://img.shields.io/github/stars/eryajf/eryajf-dockerfile?color=f2f08d&logo=Undertale&logoColor=eb4630) | ![](https://img.shields.io/github/forks/eryajf/eryajf-dockerfile?color=ba86eb&logo=Handshake&logoColor=ea6aa6) | 🏺 个人常用的Docker镜像汇总 | +| [eryajfctl](https://github.com/eryajf/eryajfctl) | ![](https://img.shields.io/github/stars/eryajf/eryajfctl?color=f2f08d&logo=Undertale&logoColor=eb4630) | ![](https://img.shields.io/github/forks/eryajf/eryajfctl?color=ba86eb&logo=Handshake&logoColor=ea6aa6) | 🚀 基于Cobra库快速打造类似kubectl一样的命令行工具箱 🧰 | +| [cloudctl](https://github.com/eryajf/cloudctl) | ![](https://img.shields.io/github/stars/eryajf/cloudctl?color=f2f08d&logo=Undertale&logoColor=eb4630) | ![](https://img.shields.io/github/forks/eryajf/cloudctl?color=ba86eb&logo=Handshake&logoColor=ea6aa6) | 🚀 与公有云等交互的命令行工具 🧰 | +| [chatgpt-wecom](https://github.com/eryajf/chatgpt-wecom) | ![](https://img.shields.io/github/stars/eryajf/chatgpt-wecom?color=f2f08d&logo=Undertale&logoColor=eb4630) | ![](https://img.shields.io/github/forks/eryajf/chatgpt-wecom?color=ba86eb&logo=Handshake&logoColor=ea6aa6) | 💬 基于GO语言实现的体验最好的企微应用集成ChatGPT项目 🚀 | +| [gitlabCodeSearch](https://github.com/eryajf/gitlabCodeSearch) | ![](https://img.shields.io/github/stars/eryajf/gitlabCodeSearch?color=f2f08d&logo=Undertale&logoColor=eb4630) | ![](https://img.shields.io/github/forks/eryajf/gitlabCodeSearch?color=ba86eb&logo=Handshake&logoColor=ea6aa6) | 🔎 使用关键字搜索所有gitlab项目 | \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 9f7bbd6..f3faa46 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,14 +1,11 @@ --- home: true -heroImage: /logo.png -heroImageStyle: { - maxWidth: '200px', - width: '100%', - display: block, - margin: '0 auto 2rem', - borderRadius: '1rem', -} -isShowTitleInHome: true -actionText: 开始 -actionLink: /views/01-basic-content/01-basic-configuration +modules: + - BannerBrand +bannerBrand: + bgImage: '/bg.svg' + title: HowToSOS + description: ⚗️ GitHub开源项目维护协作指南。 + buttons: + - { text: 开始, link: '/HowToStartOpenSource/01-basic-content/01-basic-configuration' } --- \ No newline at end of file diff --git a/docs/en/views/01-basic-content/01-basic-configuration.md b/docs/en/HowToStartOpenSource/01-basic-content/01-basic-configuration.md similarity index 100% rename from docs/en/views/01-basic-content/01-basic-configuration.md rename to docs/en/HowToStartOpenSource/01-basic-content/01-basic-configuration.md diff --git a/docs/en/views/01-basic-content/02-personal-maintenance-process.md b/docs/en/HowToStartOpenSource/01-basic-content/02-personal-maintenance-process.md similarity index 100% rename from docs/en/views/01-basic-content/02-personal-maintenance-process.md rename to docs/en/HowToStartOpenSource/01-basic-content/02-personal-maintenance-process.md diff --git a/docs/en/views/01-basic-content/03-collaborative-development-process.md b/docs/en/HowToStartOpenSource/01-basic-content/03-collaborative-development-process.md similarity index 100% rename from docs/en/views/01-basic-content/03-collaborative-development-process.md rename to docs/en/HowToStartOpenSource/01-basic-content/03-collaborative-development-process.md diff --git a/docs/en/views/01-basic-content/04-PR-and-issue.md b/docs/en/HowToStartOpenSource/01-basic-content/04-PR-and-issue.md similarity index 100% rename from docs/en/views/01-basic-content/04-PR-and-issue.md rename to docs/en/HowToStartOpenSource/01-basic-content/04-PR-and-issue.md diff --git a/docs/en/views/01-basic-content/05-How-to-configure-a-personal-GitHub-home-page-with-elegance-and-beauty.md b/docs/en/HowToStartOpenSource/01-basic-content/05-How-to-configure-a-personal-GitHub-home-page-with-elegance-and-beauty.md similarity index 100% rename from docs/en/views/01-basic-content/05-How-to-configure-a-personal-GitHub-home-page-with-elegance-and-beauty.md rename to docs/en/HowToStartOpenSource/01-basic-content/05-How-to-configure-a-personal-GitHub-home-page-with-elegance-and-beauty.md diff --git a/docs/en/views/01-basic-content/06-issue-and-PR-template.md b/docs/en/HowToStartOpenSource/01-basic-content/06-issue-and-PR-template.md similarity index 100% rename from docs/en/views/01-basic-content/06-issue-and-PR-template.md rename to docs/en/HowToStartOpenSource/01-basic-content/06-issue-and-PR-template.md diff --git a/docs/en/HowToStartOpenSource/02-github-actions/01-Automatically-add-TOC-directories-for-README.md b/docs/en/HowToStartOpenSource/02-github-actions/01-Automatically-add-TOC-directories-for-README.md new file mode 100644 index 0000000..1d6486f --- /dev/null +++ b/docs/en/HowToStartOpenSource/02-github-actions/01-Automatically-add-TOC-directories-for-README.md @@ -0,0 +1,51 @@ +--- +title: Automatically add TOC directories for README +date: 2022-07-18 17:23:23 +--- + +GitHub's Markdown does not currently support direct `[TOC]` rendering of article directories, some READMEs require such effects, which can be generated with the help of external tools or automatically generated with the help of `GitHub Actions`, which is described in this article. + +Actions used:[TOC Generator](https://github.com/marketplace/actions/toc-generator) + +Using the configuration is actually very simple, basically after reading the official introduction document you can get started to use, here is one or two things to pay attention to. + +First of all, you need to specify the directory generation location, e.g. `README.md` in the file where the directory will be generated, and add the following content in the place to be generated: + +``` + + +``` + +Then add the Actions profile,e.g. `.github/workflows/toc.yml`: + +```yml +on: push +name: TOC Generator +jobs: + generateTOC: + name: TOC Generator + runs-on: ubuntu-latest + steps: + - uses: technote-space/toc-generator@v4 +``` + +Next, you need to adjust the project's Actions permissions,Click on GitHub, `settings`--> `actions` --> `General` --> `Workflow permissions` --> choose `Read and write permissions`。 + +![image_20220718_172340](https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20220718_172340.png) + +After the configuration adjustment is completed, you can push the project to see the effect, of course, you can also pass the GitHub_Token way of certification here, so I won't repeat it. + +The effect is presented as follows: + +![image_20220719_110310](https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20220719_110310.png) + +`Configure the list:` [see](https://github.com/marketplace/actions/toc-generator#options) + + +It can be configured according to your actual needs and situation! + +## Other than that + +Later, I learned a trick in one place, it turned out that GitHub already supports the directory method by default for Markdown files, and also supports search, as follows: + +![image_20220719_110613](https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20220719_110613.png) \ No newline at end of file diff --git a/docs/en/views/02-github-actions/02-Automatically-add-the-list-of-project-contributors-to-README.md b/docs/en/HowToStartOpenSource/02-github-actions/02-Automatically-add-the-list-of-project-contributors-to-README.md similarity index 100% rename from docs/en/views/02-github-actions/02-Automatically-add-the-list-of-project-contributors-to-README.md rename to docs/en/HowToStartOpenSource/02-github-actions/02-Automatically-add-the-list-of-project-contributors-to-README.md diff --git a/docs/en/views/02-github-actions/03-Automatically-and-elegantly-build-Releases-for-the-project.md b/docs/en/HowToStartOpenSource/02-github-actions/03-Automatically-and-elegantly-build-Releases-for-the-project.md similarity index 100% rename from docs/en/views/02-github-actions/03-Automatically-and-elegantly-build-Releases-for-the-project.md rename to docs/en/HowToStartOpenSource/02-github-actions/03-Automatically-and-elegantly-build-Releases-for-the-project.md diff --git a/docs/en/views/02-github-actions/04-Automatically-get-blog-rss-articles.md b/docs/en/HowToStartOpenSource/02-github-actions/04-Automatically-get-blog-rss-articles.md similarity index 100% rename from docs/en/views/02-github-actions/04-Automatically-get-blog-rss-articles.md rename to docs/en/HowToStartOpenSource/02-github-actions/04-Automatically-get-blog-rss-articles.md diff --git a/docs/en/views/02-github-actions/05-Automatically-build-docker-images-compatible-with-multi-CPU-architecture-and-publish-to-DockerHub.md b/docs/en/HowToStartOpenSource/02-github-actions/05-Automatically-build-docker-images-compatible-with-multi-CPU-architecture-and-publish-to-DockerHub.md similarity index 100% rename from docs/en/views/02-github-actions/05-Automatically-build-docker-images-compatible-with-multi-CPU-architecture-and-publish-to-DockerHub.md rename to docs/en/HowToStartOpenSource/02-github-actions/05-Automatically-build-docker-images-compatible-with-multi-CPU-architecture-and-publish-to-DockerHub.md diff --git a/docs/en/views/02-github-actions/06-Automatically-perform-code-scan-pre-check.md b/docs/en/HowToStartOpenSource/02-github-actions/06-Automatically-perform-code-scan-pre-check.md similarity index 100% rename from docs/en/views/02-github-actions/06-Automatically-perform-code-scan-pre-check.md rename to docs/en/HowToStartOpenSource/02-github-actions/06-Automatically-perform-code-scan-pre-check.md diff --git a/docs/en/views/02-github-actions/07-Automatically-generate-Fans-for-GitHub.md b/docs/en/HowToStartOpenSource/02-github-actions/07-Automatically-generate-Fans-for-GitHub.md similarity index 100% rename from docs/en/views/02-github-actions/07-Automatically-generate-Fans-for-GitHub.md rename to docs/en/HowToStartOpenSource/02-github-actions/07-Automatically-generate-Fans-for-GitHub.md diff --git a/docs/en/views/02-github-actions/08-Automatically-generate-a-personal-star-list-and-classify-it.md b/docs/en/HowToStartOpenSource/02-github-actions/08-Automatically-generate-a-personal-star-list-and-classify-it.md similarity index 100% rename from docs/en/views/02-github-actions/08-Automatically-generate-a-personal-star-list-and-classify-it.md rename to docs/en/HowToStartOpenSource/02-github-actions/08-Automatically-generate-a-personal-star-list-and-classify-it.md diff --git a/docs/en/views/02-github-actions/09-Automatically-get-the-project-current-star-and-fork-to-write-to-Description.md b/docs/en/HowToStartOpenSource/02-github-actions/09-Automatically-get-the-project-current-star-and-fork-to-write-to-Description.md similarity index 100% rename from docs/en/views/02-github-actions/09-Automatically-get-the-project-current-star-and-fork-to-write-to-Description.md rename to docs/en/HowToStartOpenSource/02-github-actions/09-Automatically-get-the-project-current-star-and-fork-to-write-to-Description.md diff --git a/docs/en/views/02-github-actions/10-Automatic-lossless-compression-of-pictures-in-the-warehouse.md b/docs/en/HowToStartOpenSource/02-github-actions/10-Automatic-lossless-compression-of-pictures-in-the-warehouse.md similarity index 100% rename from docs/en/views/02-github-actions/10-Automatic-lossless-compression-of-pictures-in-the-warehouse.md rename to docs/en/HowToStartOpenSource/02-github-actions/10-Automatic-lossless-compression-of-pictures-in-the-warehouse.md diff --git a/docs/en/views/02-github-actions/11-Automatically-detect-problem-links-in-the-project.md b/docs/en/HowToStartOpenSource/02-github-actions/11-Automatically-detect-problem-links-in-the-project.md similarity index 100% rename from docs/en/views/02-github-actions/11-Automatically-detect-problem-links-in-the-project.md rename to docs/en/HowToStartOpenSource/02-github-actions/11-Automatically-detect-problem-links-in-the-project.md diff --git a/docs/en/views/02-github-actions/12-Automatically-build-binary-to-release-of-go-project.md b/docs/en/HowToStartOpenSource/02-github-actions/12-Automatically-build-binary-to-release-of-go-project.md similarity index 100% rename from docs/en/views/02-github-actions/12-Automatically-build-binary-to-release-of-go-project.md rename to docs/en/HowToStartOpenSource/02-github-actions/12-Automatically-build-binary-to-release-of-go-project.md diff --git a/docs/en/views/03-github-tips/01-How-to-center-the-table-in-README.md b/docs/en/HowToStartOpenSource/03-github-tips/01-How-to-center-the-table-in-README.md similarity index 100% rename from docs/en/views/03-github-tips/01-How-to-center-the-table-in-README.md rename to docs/en/HowToStartOpenSource/03-github-tips/01-How-to-center-the-table-in-README.md diff --git a/docs/en/views/03-github-tips/02-How-to-configure-multiple-GitHub-accounts-on-one-computer.md b/docs/en/HowToStartOpenSource/03-github-tips/02-How-to-configure-multiple-GitHub-accounts-on-one-computer.md similarity index 100% rename from docs/en/views/03-github-tips/02-How-to-configure-multiple-GitHub-accounts-on-one-computer.md rename to docs/en/HowToStartOpenSource/03-github-tips/02-How-to-configure-multiple-GitHub-accounts-on-one-computer.md diff --git a/docs/en/views/03-github-tips/03-How-to-merge-multiple-submissions-into-one.md b/docs/en/HowToStartOpenSource/03-github-tips/03-How-to-merge-multiple-submissions-into-one.md similarity index 100% rename from docs/en/views/03-github-tips/03-How-to-merge-multiple-submissions-into-one.md rename to docs/en/HowToStartOpenSource/03-github-tips/03-How-to-merge-multiple-submissions-into-one.md diff --git a/docs/en/views/03-github-tips/04-The-skill-of-reading-code-and-running-code.md b/docs/en/HowToStartOpenSource/03-github-tips/04-The-skill-of-reading-code-and-running-code.md similarity index 100% rename from docs/en/views/03-github-tips/04-The-skill-of-reading-code-and-running-code.md rename to docs/en/HowToStartOpenSource/03-github-tips/04-The-skill-of-reading-code-and-running-code.md diff --git a/docs/en/views/03-github-tips/05-Summary-using-GitHub-keyboard-shortcuts.md b/docs/en/HowToStartOpenSource/03-github-tips/05-Summary-using-GitHub-keyboard-shortcuts.md similarity index 100% rename from docs/en/views/03-github-tips/05-Summary-using-GitHub-keyboard-shortcuts.md rename to docs/en/HowToStartOpenSource/03-github-tips/05-Summary-using-GitHub-keyboard-shortcuts.md diff --git a/docs/views/03-github-tips/06-Summary-and-arrangement-of-personal-open-source-project-recommendation-platform.md b/docs/en/HowToStartOpenSource/03-github-tips/06-Summary-and-arrangement-of-personal-open-source-project-recommendation-platform.md similarity index 100% rename from docs/views/03-github-tips/06-Summary-and-arrangement-of-personal-open-source-project-recommendation-platform.md rename to docs/en/HowToStartOpenSource/03-github-tips/06-Summary-and-arrangement-of-personal-open-source-project-recommendation-platform.md diff --git a/docs/en/views/03-github-tips/07-How-to-bind-a-custom-domain-name-to-GitHub-Pages.md b/docs/en/HowToStartOpenSource/03-github-tips/07-How-to-bind-a-custom-domain-name-to-GitHub-Pages.md similarity index 100% rename from docs/en/views/03-github-tips/07-How-to-bind-a-custom-domain-name-to-GitHub-Pages.md rename to docs/en/HowToStartOpenSource/03-github-tips/07-How-to-bind-a-custom-domain-name-to-GitHub-Pages.md diff --git a/docs/en/views/03-github-tips/08-How-to-deal-with-the-problem-that-file-name-conversion-case-cannot-be-submitted-in-Git.md b/docs/en/HowToStartOpenSource/03-github-tips/08-How-to-deal-with-the-problem-that-file-name-conversion-case-cannot-be-submitted-in-Git.md similarity index 100% rename from docs/en/views/03-github-tips/08-How-to-deal-with-the-problem-that-file-name-conversion-case-cannot-be-submitted-in-Git.md rename to docs/en/HowToStartOpenSource/03-github-tips/08-How-to-deal-with-the-problem-that-file-name-conversion-case-cannot-be-submitted-in-Git.md diff --git a/docs/en/views/03-github-tips/09-How-to-use-pre-commit-to-standardize-coding.md b/docs/en/HowToStartOpenSource/03-github-tips/09-How-to-use-pre-commit-to-standardize-coding.md similarity index 100% rename from docs/en/views/03-github-tips/09-How-to-use-pre-commit-to-standardize-coding.md rename to docs/en/HowToStartOpenSource/03-github-tips/09-How-to-use-pre-commit-to-standardize-coding.md diff --git a/docs/en/views/03-github-tips/10-Use-github-slug-action-to-leak-key-variables-in-the-Github-Action-context.md b/docs/en/HowToStartOpenSource/03-github-tips/10-Use-github-slug-action-to-leak-key-variables-in-the-Github-Action-context.md similarity index 100% rename from docs/en/views/03-github-tips/10-Use-github-slug-action-to-leak-key-variables-in-the-Github-Action-context.md rename to docs/en/HowToStartOpenSource/03-github-tips/10-Use-github-slug-action-to-leak-key-variables-in-the-Github-Action-context.md diff --git a/docs/en/views/other/myopensource.md b/docs/en/HowToStartOpenSource/other/myopensource.md similarity index 100% rename from docs/en/views/other/myopensource.md rename to docs/en/HowToStartOpenSource/other/myopensource.md diff --git a/docs/en/README.md b/docs/en/README.md index 730af87..a0918aa 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -1,14 +1,11 @@ --- home: true -heroImage: /logo.png -heroImageStyle: { - maxWidth: '200px', - width: '100%', - display: block, - margin: '5rem auto 2rem', - borderRadius: '1rem', -} -isShowTitleInHome: true -actionText: Start -actionLink: /en/views/01-basic-content/01-basic-configuration ---- +modules: + - BannerBrand +bannerBrand: + bgImage: '/bg.svg' + title: HowToSOS + description: ⚗️ GitHub Open source project maintenance collaboration guide + buttons: + - { text: Start, link: '/en/HowToStartOpenSource/01-basic-content/01-basic-configuration' } +--- \ No newline at end of file diff --git a/docs/en/views/02-github-actions/01-Automatically-add-TOC-directories-for-README.md b/docs/en/views/02-github-actions/01-Automatically-add-TOC-directories-for-README.md deleted file mode 100644 index a6cd6d6..0000000 --- a/docs/en/views/02-github-actions/01-Automatically-add-TOC-directories-for-README.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Automatically add TOC directories for README -date: 2022-07-18 17:23:23 ---- - -GitHub's Markdown does not currently support direct `[TOC]` rendering of article directories, some READMEs require such effects, which can be generated with the help of external tools or automatically generated with the help of `GitHub Actions`, which is described in this article. - -Actions used:[TOC Generator](https://github.com/marketplace/actions/toc-generator) - -Using the configuration is actually very simple, basically after reading the official introduction document you can get started to use, here is one or two things to pay attention to. - -First of all, you need to specify the directory generation location, e.g. `README.md` in the file where the directory will be generated, and add the following content in the place to be generated: - -``` - - -``` - -Then add the Actions profile,e.g. `.github/workflows/toc.yml`: - -```yml -on: push -name: TOC Generator -jobs: - generateTOC: - name: TOC Generator - runs-on: ubuntu-latest - steps: - - uses: technote-space/toc-generator@v4 -``` - -Next, you need to adjust the project's Actions permissions,Click on GitHub, `settings`--> `actions` --> `General` --> `Workflow permissions` --> choose `Read and write permissions`。 - -![image_20220718_172340](https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20220718_172340.png) - -After the configuration adjustment is completed, you can push the project to see the effect, of course, you can also pass the GitHub_Token way of certification here, so I won't repeat it. - -The effect is presented as follows: - -![image_20220719_110310](https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20220719_110310.png) - -`Configure the list:` - -::: v-pre -| name | description | default | required | e.g. | -| ------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -------- | ------------------------------ | -| TARGET_PATHS | Target file path. (Comma separated, [Detail](https://github.com/thlorenz/doctoc#adding-toc-to-individual-files)) | `README*.md` | true | `README*.md,CHANGELOG.md`, `.` | -| TOC_TITLE | TOC Title | `**Table of Contents**` | | `''` | -| MAX_HEADER_LEVEL | Maximum heading level. ([Detail](https://github.com/thlorenz/doctoc#specifying-a-maximum-heading-level-for-toc-entries)) | | | `3` | -| CUSTOM_MODE | Whether it is custom mode([Generated Example](https://github.com/technote-space/toc-generator/blob/main/samples/README.horizontal.md)) | `false` | | `true` | -| CUSTOM_TEMPLATE | Custom template for custom mode | `

${ITEMS}

` | | | -| ITEM_TEMPLATE | Item template for custom mode | `${TEXT}` | | | -| SEPARATOR | Separator for custom mode | `|` | | | -| FOLDING | Whether to make TOC foldable | `false` | | `true` | -| COMMIT_MESSAGE | Commit message | `chore(docs): update TOC` | true | `docs: update TOC` | -| COMMIT_NAME | Git commit name | `${github.actor}` | | | -| COMMIT_EMAIL | Git commit email | `${github.actor}@users.noreply.github.com` | | | -| CREATE_PR | Whether to create PullRequest | `false` | | `true` | -| CHECK_ONLY_DEFAULT_BRANCH | Whether to check only default branch | `false` | | `true` | -| PR_BRANCH_PREFIX | PullRequest branch prefix | `toc-generator/` | true | | -| PR_BRANCH_NAME | PullRequest branch name [Context variables](https://github.com/marketplace/actions/toc-generator#context-variables) | `update-toc-${PR_ID}` | true | `toc-${PR_NUMBER}` | -| PR_TITLE | PullRequest title [Context variables](https://github.com/marketplace/actions/toc-generator#context-variables) | `chore(docs): update TOC (${PR_MERGE_REF})` | true | `docs: update TOC` | -| PR_BODY | PullRequest body [Context PR variables](https://github.com/marketplace/actions/toc-generator#context-pr-variables) | [action.yml](https://github.com/technote-space/toc-generator/blob/main/action.yml) | true | | -| PR_COMMENT_BODY | PullRequest body for comment [Context PR variables](https://github.com/marketplace/actions/toc-generator#context-pr-variables) | [action.yml](https://github.com/technote-space/toc-generator/blob/main/action.yml) | | | -| PR_CLOSE_MESSAGE | Message body when closing PullRequest | `This PR has been closed because it is no longer needed.` | | | -| TARGET_BRANCH_PREFIX | Filter by branch name | | | `release/` | -| INCLUDE_LABELS | Labels used to check if the PullRequest has it | | | `Label1, Label2` | -| OPENING_COMMENT | Opening comment (for other than DocToc) | ` - -``` - -然后添加Actions配置文件,e.g. `.github/workflows/toc.yml`: - -```yml -on: push -name: TOC Generator -jobs: - generateTOC: - name: TOC Generator - runs-on: ubuntu-latest - steps: - - uses: technote-space/toc-generator@v4 -``` - -接着需要调整下项目的Actions权限,在GitHub上点击`settings`--> `actions` --> `General` --> `Workflow permissions` --> 选择 `Read and write permissions`。 - -![image_20220718_172340](https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20220718_172340.png) - -配置调整完成之后,就可以push项目看效果了,当然这里也可以通过GitHub_Token的方式认证,就不赘述了。 - -效果呈现如下: - -![image_20220719_110310](https://cdn.staticaly.com/gh/eryajf/tu/main/img/image_20220719_110310.png) - -`配置列表:` - -::: v-pre -| name | description | default | required | e.g. | -| ------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -------- | ------------------------------ | -| TARGET_PATHS | Target file path. (Comma separated, [Detail](https://github.com/thlorenz/doctoc#adding-toc-to-individual-files)) | `README*.md` | true | `README*.md,CHANGELOG.md`, `.` | -| TOC_TITLE | TOC Title | `**Table of Contents**` | | `''` | -| MAX_HEADER_LEVEL | Maximum heading level. ([Detail](https://github.com/thlorenz/doctoc#specifying-a-maximum-heading-level-for-toc-entries)) | | | `3` | -| CUSTOM_MODE | Whether it is custom mode([Generated Example](https://github.com/technote-space/toc-generator/blob/main/samples/README.horizontal.md)) | `false` | | `true` | -| CUSTOM_TEMPLATE | Custom template for custom mode | `

${ITEMS}

` | | | -| ITEM_TEMPLATE | Item template for custom mode | `${TEXT}` | | | -| SEPARATOR | Separator for custom mode | `|` | | | -| FOLDING | Whether to make TOC foldable | `false` | | `true` | -| COMMIT_MESSAGE | Commit message | `chore(docs): update TOC` | true | `docs: update TOC` | -| COMMIT_NAME | Git commit name | `${github.actor}` | | | -| COMMIT_EMAIL | Git commit email | `${github.actor}@users.noreply.github.com` | | | -| CREATE_PR | Whether to create PullRequest | `false` | | `true` | -| CHECK_ONLY_DEFAULT_BRANCH | Whether to check only default branch | `false` | | `true` | -| PR_BRANCH_PREFIX | PullRequest branch prefix | `toc-generator/` | true | | -| PR_BRANCH_NAME | PullRequest branch name [Context variables](https://github.com/marketplace/actions/toc-generator#context-variables) | `update-toc-${PR_ID}` | true | `toc-${PR_NUMBER}` | -| PR_TITLE | PullRequest title [Context variables](https://github.com/marketplace/actions/toc-generator#context-variables) | `chore(docs): update TOC (${PR_MERGE_REF})` | true | `docs: update TOC` | -| PR_BODY | PullRequest body [Context PR variables](https://github.com/marketplace/actions/toc-generator#context-pr-variables) | [action.yml](https://github.com/technote-space/toc-generator/blob/main/action.yml) | true | | -| PR_COMMENT_BODY | PullRequest body for comment [Context PR variables](https://github.com/marketplace/actions/toc-generator#context-pr-variables) | [action.yml](https://github.com/technote-space/toc-generator/blob/main/action.yml) | | | -| PR_CLOSE_MESSAGE | Message body when closing PullRequest | `This PR has been closed because it is no longer needed.` | | | -| TARGET_BRANCH_PREFIX | Filter by branch name | | | `release/` | -| INCLUDE_LABELS | Labels used to check if the PullRequest has it | | | `Label1, Label2` | -| OPENING_COMMENT | Opening comment (for other than DocToc) | `