public
nobgit
read
community.wiki
For NobGit Community
Create file
Wiki Documentation
Clone
https://nobgit.com/orgs/nobgit/community.wiki.git
ssh://[email protected]:2222/orgs/nobgit/community.wiki.git
Trace
Repositories/Wikis.md
Trace helps you understand code history line by line. See who changed each line, when it changed, and which commit introduced it.
Author
Date
Commit
Line
Code
1
# How to use Wiki
3
Wiki is the best way to give users knowledge about your code, project decisions, setup steps, and release notes that do not belong directly in the repository README.
5
## Create wiki pages in the web UI
7
1. Open any repository that needs a wiki.
8
2. Open **Wiki**.
9
3. Create a page manually from the web UI.
10
4. Give the page a clear title and write the content in Markdown.
11
5. Save the page.
13
## Use a wiki source repository
15
You can also manage wiki pages with Git by using the repository's wiki source repo. NobGit names wiki source repos by adding `.wiki` to the original repository slug.
17
For example:
19
- `dotslash` uses `dotslash.wiki`
20
- `wiki` uses `wiki.wiki`
22
The wiki source repo must belong to the same owner as the original repository. For example, `/orgs/nobgit/wiki` uses `/orgs/nobgit/wiki.wiki`.
24
This lets you push Markdown files to the wiki from your editor. The wiki source repo is normally hidden from public discovery and regular repository lists, but it can still be opened directly.
26
## Wiki file format
28
Wiki pages are Markdown files. Root Markdown files appear as pages in the wiki overview.
30
```text
31
How to get started.md
32
How to create repo.md
33
How to create an access token.md
34
```
36
You can also organize pages into folders. Folders become chapters, and Markdown files inside them become pages.
38
```text
39
Get started/
40
How to get started.md
41
How to create repo.md
42
How to create an access token.md
43
```
45
- [Previous: releases](How to upload and use releases.md)
47
- [Next: passkey or OTP](How to add a passkey or OTP.md)