public
nobgit
read
wiki.wiki
No description yet
Create file
Wiki Documentation
Clone
https://nobgit.com/orgs/nobgit/wiki.wiki.git
ssh://[email protected]:2222/orgs/nobgit/wiki.wiki.git
Trace
How to use Wiki.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 repository
15
You can also manage wiki pages with Git by using the repository's `.wiki` repo. For example, if a NobGit repository is called `DotSlash`, its wiki repo is called `dotslash.wiki`.
17
This lets you push Markdown files to the wiki. The wiki repo is normally hidden from search and does not show in your regular repository list. To make changes, open the repository that has the wiki.
19
## Wiki file format
21
Wiki pages are Markdown files. Use clear file names so each page maps cleanly to one wiki page.
23
```
24
How to get started.md
25
How to create repo.md
26
How to create an access token.md
27
```
29
You can also organize pages into folders:
31
```
32
Get started/
33
How to get started.md
34
How to create repo.md
35
How to create an access token.md
36
```
38
- [Previous: releases](How to upload and use releases.md)
40
- [Next: passkey or OTP](How to add a passkey or OTP.md)