René's URL Explorer Experiment


Title: GitHub - frank-lam/docs-tutorial: ✍️ 开发者如何编写优雅的技术文档

Open Graph Title: GitHub - frank-lam/docs-tutorial: ✍️ 开发者如何编写优雅的技术文档

X Title: GitHub - frank-lam/docs-tutorial: ✍️ 开发者如何编写优雅的技术文档

Description: ✍️ 开发者如何编写优雅的技术文档. Contribute to frank-lam/docs-tutorial development by creating an account on GitHub.

Open Graph Description: ✍️ 开发者如何编写优雅的技术文档. Contribute to frank-lam/docs-tutorial development by creating an account on GitHub.

X Description: ✍️ 开发者如何编写优雅的技术文档. Contribute to frank-lam/docs-tutorial development by creating an account on GitHub.

Opengraph URL: https://github.com/frank-lam/docs-tutorial

X: @github

direct link

Domain: github.com

route-pattern/:user_id/:repository
route-controllerfiles
route-actiondisambiguate
fetch-noncev2:79778285-2d7c-dcd5-77a9-2b08f4d4bed7
current-catalog-service-hashf3abb0cc802f3d7b95fc8762b94bdcb13bf39634c40c357301c4aa1d67a256fb
request-idD6F0:35B0FD:106105B:1669504:696943B4
html-safe-nonce1895dc252c683337f3f2ed8b82f007a1f9830cc80d247df268943c86ec82027c
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJENkYwOjM1QjBGRDoxMDYxMDVCOjE2Njk1MDQ6Njk2OTQzQjQiLCJ2aXNpdG9yX2lkIjoiMTUzMTIyMzk1MjM4Mzg4NjI2MCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmac8eec09b293c83878de995e28bd562d99e60f75a5a0a193224719857438817907
hovercard-subject-tagrepository:332272018
github-keyboard-shortcutsrepository,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location//
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/frank-lam/docs-tutorial
twitter:imagehttps://opengraph.githubassets.com/493d90bce0959480bbdb99267123ec9d98683619ee6e4b818f5979c123d5dbaa/frank-lam/docs-tutorial
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/493d90bce0959480bbdb99267123ec9d98683619ee6e4b818f5979c123d5dbaa/frank-lam/docs-tutorial
og:image:alt✍️ 开发者如何编写优雅的技术文档. Contribute to frank-lam/docs-tutorial development by creating an account on GitHub.
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
None54182691a21263b584d2e600b758e081b0ff1d10ffc0d2eefa51cf754b43b51d
turbo-cache-controlno-preview
go-importgithub.com/frank-lam/docs-tutorial git https://github.com/frank-lam/docs-tutorial.git
octolytics-dimension-user_id19153458
octolytics-dimension-user_loginfrank-lam
octolytics-dimension-repository_id332272018
octolytics-dimension-repository_nwofrank-lam/docs-tutorial
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id332272018
octolytics-dimension-repository_network_root_nwofrank-lam/docs-tutorial
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
released69ac0477df0f87da03b8b06cebd187012d7a930
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/frank-lam/docs-tutorial#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Ffrank-lam%2Fdocs-tutorial
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub SparkBuild and deploy intelligent appshttps://github.com/features/spark
GitHub ModelsManage and compare promptshttps://github.com/features/models
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
GitHub SponsorsFund open source developershttps://github.com/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/accelerator
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://github.com/security/advanced-security
Copilot for BusinessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Ffrank-lam%2Fdocs-tutorial
Sign up https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E&source=header-repo&source_repo=frank-lam%2Fdocs-tutorial
Reloadhttps://github.com/frank-lam/docs-tutorial
Reloadhttps://github.com/frank-lam/docs-tutorial
Reloadhttps://github.com/frank-lam/docs-tutorial
frank-lam https://github.com/frank-lam
docs-tutorialhttps://github.com/frank-lam/docs-tutorial
Notifications https://github.com/login?return_to=%2Ffrank-lam%2Fdocs-tutorial
Fork 6 https://github.com/login?return_to=%2Ffrank-lam%2Fdocs-tutorial
Star 103 https://github.com/login?return_to=%2Ffrank-lam%2Fdocs-tutorial
103 stars https://github.com/frank-lam/docs-tutorial/stargazers
6 forks https://github.com/frank-lam/docs-tutorial/forks
Branches https://github.com/frank-lam/docs-tutorial/branches
Tags https://github.com/frank-lam/docs-tutorial/tags
Activity https://github.com/frank-lam/docs-tutorial/activity
Star https://github.com/login?return_to=%2Ffrank-lam%2Fdocs-tutorial
Notifications https://github.com/login?return_to=%2Ffrank-lam%2Fdocs-tutorial
Code https://github.com/frank-lam/docs-tutorial
Issues 0 https://github.com/frank-lam/docs-tutorial/issues
Pull requests 0 https://github.com/frank-lam/docs-tutorial/pulls
Actions https://github.com/frank-lam/docs-tutorial/actions
Projects 0 https://github.com/frank-lam/docs-tutorial/projects
Security Uh oh! There was an error while loading. Please reload this page. https://github.com/frank-lam/docs-tutorial/security
Please reload this pagehttps://github.com/frank-lam/docs-tutorial
Insights https://github.com/frank-lam/docs-tutorial/pulse
Code https://github.com/frank-lam/docs-tutorial
Issues https://github.com/frank-lam/docs-tutorial/issues
Pull requests https://github.com/frank-lam/docs-tutorial/pulls
Actions https://github.com/frank-lam/docs-tutorial/actions
Projects https://github.com/frank-lam/docs-tutorial/projects
Security https://github.com/frank-lam/docs-tutorial/security
Insights https://github.com/frank-lam/docs-tutorial/pulse
Brancheshttps://github.com/frank-lam/docs-tutorial/branches
Tagshttps://github.com/frank-lam/docs-tutorial/tags
https://github.com/frank-lam/docs-tutorial/branches
https://github.com/frank-lam/docs-tutorial/tags
24 Commitshttps://github.com/frank-lam/docs-tutorial/commits/main/
https://github.com/frank-lam/docs-tutorial/commits/main/
assetshttps://github.com/frank-lam/docs-tutorial/tree/main/assets
assetshttps://github.com/frank-lam/docs-tutorial/tree/main/assets
README.mdhttps://github.com/frank-lam/docs-tutorial/blob/main/README.md
README.mdhttps://github.com/frank-lam/docs-tutorial/blob/main/README.md
READMEhttps://github.com/frank-lam/docs-tutorial
https://github.com/frank-lam/docs-tutorial#开发者如何编写优雅的技术文档
https://github.com/frank-lam/docs-tutorial#前言
https://github.com/frank-lam/docs-tutorial#一文档排版
https://github.com/frank-lam/docs-tutorial#1-markdown
https://github.com/frank-lam/docs-tutorial#为什么要学习-markdown
https://github.com/frank-lam/docs-tutorial#基本语法
https://github.com/cdoco/markdown-syntax。对于基础语法，笔者认为略有了解即可，在下面将会隆重https://github.com/cdoco/markdown-syntax%E3%80%82%E5%AF%B9%E4%BA%8E%E5%9F%BA%E7%A1%80%E8%AF%AD%E6%B3%95%EF%BC%8C%E7%AC%94%E8%80%85%E8%AE%A4%E4%B8%BA%E7%95%A5%E6%9C%89%E4%BA%86%E8%A7%A3%E5%8D%B3%E5%8F%AF%EF%BC%8C%E5%9C%A8%E4%B8%8B%E9%9D%A2%E5%B0%86%E4%BC%9A%E9%9A%86%E9%87%8D
https://zh.wikipedia.org/zh-hans/Markdownhttps://zh.wikipedia.org/zh-hans/Markdown
https://github.com/frank-lam/docs-tutorial#2-typora-软件使用技巧
https://www.typora.iohttps://www.typora.io
https://github.com/frank-lam/docs-tutorial/blob/main/assets/image-20210515112200475.png
https://github.com/frank-lam/docs-tutorial/blob/main/assets/image-20210515112156886.png
https://github.com/frank-lam/docs-tutorial#所见即所得
https://github.com/frank-lam/docs-tutorial#图片管理
https://github.com/frank-lam/docs-tutorial#表格编辑
https://github.com/frank-lam/docs-tutorial#快捷键提效
https://github.com/frank-lam/docs-tutorial#3-提效辅助插件
https://github.com/frank-lam/docs-tutorial#tabcopy---chrome-插件
https://chrome.google.com/webstore/detail/tabcopy/micdllihgoppmejpecmkilggmaagfdmb?utm_source=chrome-ntp-iconhttps://chrome.google.com/webstore/detail/tabcopy/micdllihgoppmejpecmkilggmaagfdmb?utm_source=chrome-ntp-icon
https://github.com/frank-lam/docs-tutorial/blob/main/assets/image-20210314012827724.png
https://github.com/frank-lam/docs-tutorial#拷贝猫---chrome-插件
https://chrome.google.com/webstore/detail/copycat/jdjbiojkklnaeoanimopafmnmhldejbg?hl=zh-CNhttps://chrome.google.com/webstore/detail/copycat/jdjbiojkklnaeoanimopafmnmhldejbg?hl=zh-CN
https://github.com/frank-lam/docs-tutorial/blob/main/assets/image-20210515102236248.png
https://github.com/frank-lam/docs-tutorial#vscode-toc-目录生成插件
https://github.com/frank-lam/docs-tutorial/blob/main/assets/image-20210314002508169.png
https://marketplace.visualstudio.com/items?itemName=AlanWalk.markdown-tochttps://marketplace.visualstudio.com/items?itemName=AlanWalk.markdown-toc
https://github.com/frank-lam/docs-tutorial/blob/main/assets/image-20210314002330558.png
https://github.com/frank-lam/docs-tutorial/blob/main/assets/image-20210314002358591.png
https://github.com/frank-lam/docs-tutorial#3-绘图与标注
https://github.com/frank-lam/docs-tutorial#drawio
https://app.diagrams.nethttps://app.diagrams.net
https://chrome.google.com/webstore/detail/diagramsnet-and-drawio-im/cnoplimhpndhhhnmoigbanpjeghjpohi?utm_source=chrome-ntp-iconhttps://chrome.google.com/webstore/detail/diagramsnet-and-drawio-im/cnoplimhpndhhhnmoigbanpjeghjpohi?utm_source=chrome-ntp-icon
https://www.diagrams.nethttps://www.diagrams.net
https://github.com/frank-lam/docs-tutorial/blob/main/assets/image-20210314003521112.png
https://github.com/frank-lam/docs-tutorial#截图软件-snipaste
https://zh.snipaste.comhttps://zh.snipaste.com
https://github.com/frank-lam/docs-tutorial/blob/main/assets/N3QEb3VA.png
https://github.com/frank-lam/docs-tutorial#4-版本控制
https://www.sourcetreeapp.comhttps://www.sourcetreeapp.com
https://github.com/frank-lam/docs-tutorial#sourcetree
https://github.com/frank-lam/docs-tutorial/blob/main/assets/image-20210314003028491.png
https://github.com/frank-lam/docs-tutorial/blob/main/assets/image-20210314003049439.png
https://github.com/frank-lam/docs-tutorial#5-排版规范
https://github.com/frank-lam/docs-tutorial#中英文标点
https://github.com/frank-lam/docs-tutorial#专用名词拼写
https://github.com/frank-lam/docs-tutorial#英文左右空格
https://github.com/frank-lam/docs-tutorial#使用代码块和代码高亮
https://github.com/frank-lam/docs-tutorial#二文档行文
https://github.com/frank-lam/docs-tutorial#1-句子长度
https://github.com/frank-lam/docs-tutorial#2-图文并茂
https://github.com/frank-lam/docs-tutorial#3-起承转合
https://github.com/frank-lam/docs-tutorial#4-引用链接
https://github.com/frank-lam/docs-tutorial#附录主流文档协作平台
https://thoughts.teambition.comhttps://thoughts.teambition.com
https://shimo.imhttps://shimo.im
https://www.feishu.cnhttps://www.feishu.cn
https://www.yuque.comhttps://www.yuque.com
https://github.com/frank-lam/docs-tutorial#参考引用
https://kalasearch.cn/blog/writing-guide-for-programmershttps://kalasearch.cn/blog/writing-guide-for-programmers
https://camo.githubusercontent.com/4692ec72b695cba11fa385ecc5191f8a645af9df3c8597623c6928bea7991ee6/68747470733a2f2f6672616e6b2d6c616d2e6769746875622e696f2f7075626c69632d7374617469632d7265736f75726365732f6173736574732f7765636861742f77782d67726f75702d7172636f64652e706e67
Readme https://github.com/frank-lam/docs-tutorial#readme-ov-file
Please reload this pagehttps://github.com/frank-lam/docs-tutorial
Activityhttps://github.com/frank-lam/docs-tutorial/activity
103 starshttps://github.com/frank-lam/docs-tutorial/stargazers
2 watchinghttps://github.com/frank-lam/docs-tutorial/watchers
6 forkshttps://github.com/frank-lam/docs-tutorial/forks
Report repository https://github.com/contact/report-content?content_url=https%3A%2F%2Fgithub.com%2Ffrank-lam%2Fdocs-tutorial&report=frank-lam+%28user%29
Releaseshttps://github.com/frank-lam/docs-tutorial/releases
Packages 0https://github.com/users/frank-lam/packages?repo_name=docs-tutorial
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width

URLs of crawlers that visited me.