Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explain better how content is imported #52

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions storage/git.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,21 @@ When enabling the Git storage module for the first time with a remote repository

To force an import of all content currently present in the local repository, load the **Git** module settings tab in the Administration Area (under **Storage**), scroll to the very bottom of the page and click **Run** button on the **Import Everything** action card.

### The import process

Wiki.js is a powerful platform that automatically imports eligible files from your repository into a database as a page.
It achieves this by walking your repository directory structure.

The directory structure of your repository is leveraged to generate unique URLs for each page.
For instance, suppose you have a root directory called `mygitdoc` and a child page named `page1.md`.
In that case, the page will be accessible at the path `http://YouWiki/mygitdoc/page1`.

It is important to note that you can still make edits to your pages using these editors.
However, it is crucial to avoid conflicts between the paths of pages created using the built-in editor and those generated from your repository's directory structure.

Moreover, you can customize your markdown files further by including additional properties such as tags, descriptions, and titles using a simple YAML header.
For example, see [the plain code of this page](https://github.com/requarks/wiki-docs/blob/master/storage/git.md?plain=1) for a sample.

## Missing Content in Remote Repository

If content was created in Wiki.js before you enabled the Git storage module or if you temporarily disabled the module, that content will be missing from the remote Git repository.
Expand Down