Tools
DVCS
DVCS
  • Git
    • git
      • git回撤commit
    • github
      • github的项目发布release
    • Submodule
      • 设置submodule子模块
      • 已有库设置子模块
      • 设置子模块的文件
      • 更新仓库的同时更新子模块
      • 更新库依赖本地库
  • Fossil
    • 源码地址
    • 和git区别
    • fossil基本使用
    • fossil应用与项目的例子
  • 区别
    • wiki
      • github上的wiki
      • fossil上的wiki
Powered by GitBook
On this page
  1. 区别
  2. wiki

github上的wiki

Git 本身并没有内置的 Wiki 功能,但你可以通过一些方法为 Git 项目创建和管理 Wiki,尤其是在使用像 GitHub、GitLab 这样的平台时,它们为项目提供了内置的 Wiki 系统。

以下是不同平台上的 Git 仓库如何管理 Wiki 的方法:

1. GitHub 项目 Wiki

  • 在 GitHub 上,每个项目都有一个默认的 Wiki 关联,你可以直接在 Web 界面中进行编辑。

  • 本地克隆 Wiki 仓库: 如果你想在本地编辑并推送到 GitHub Wiki,GitHub 允许你将 Wiki 仓库作为独立的 Git 仓库进行克隆。

    使用以下命令克隆 GitHub 项目的 Wiki 仓库:

    git clone https://github.com/username/repository.wiki.git

    在该仓库中,你可以创建和编辑 Markdown 文件,提交更改后推送回 GitHub:

    git add .
    git commit -m "Update Wiki"
    git push

2. GitLab 项目 Wiki

  • 类似 GitHub,GitLab 也为每个项目提供了一个内置的 Wiki 系统。

  • 本地克隆 Wiki 仓库: GitLab 也允许你在本地克隆 Wiki 仓库,命令如下:

    git clone https://gitlab.com/username/repository.wiki.git

    然后你可以在本地编辑 Wiki 文件并推送:

    git add .
    git commit -m "Update Wiki"
    git push

3. 手动创建 Git Wiki

如果你不依赖任何平台的内置 Wiki 功能,而是想在本地或者独立的 Git 仓库中管理 Wiki,可以按照以下步骤手动创建:

  • 创建一个独立的 Wiki 仓库: 你可以为项目创建一个单独的 Git 仓库,用于管理文档或 Wiki 内容。命令如下:

    git init wiki-repo
    cd wiki-repo
  • 在仓库中创建文档: 创建 Markdown 文件(或其他格式的文档),并提交到这个仓库中:

    echo "# Wiki Home" > README.md
    git add README.md
    git commit -m "Initial Wiki commit"
  • 与主项目关联: 如果你想将这个 Wiki 仓库与主项目关联,可以通过 README 文件或文档中提供链接指向这个 Wiki 仓库。

总结

Git 本身没有内置 Wiki 命令,但你可以通过像 GitHub、GitLab 这样的平台使用他们提供的 Wiki 仓库功能,或者创建独立的 Git 仓库来手动管理 Wiki 文档。

PreviouswikiNextfossil上的wiki

Last updated 8 months ago