-
-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
78132fa
commit 463a60d
Showing
3 changed files
with
36 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,9 @@ | ||
## 0.8.4 | ||
|
||
### Prs in Release | ||
|
||
- [Fix SSH urls to HTTPS]() | ||
|
||
## 0.8.3 | ||
|
||
### Prs in Release | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -174,6 +174,24 @@ Once you're done configuring, run either `mkdocs serve` or `mkdocs build`. This | |
|
||
## Additional Features | ||
|
||
### Support ssh urls for import | ||
|
||
If an imported repo is imported via an ssh connection, the edit url needs to be modified to reflect an https link. | ||
|
||
``` | ||
plugins: | ||
- search | ||
- awesome-pages | ||
- multirepo: | ||
cleanup: false | ||
repos: | ||
- section: Some MKDocs Repo | ||
section_path: mkdocs | ||
import_url: 'ssh://[email protected]/mkdocs/some-repo?branch=main&edit_uri=blob/main/docs' | ||
``` | ||
This url is modified to remove the `ssh://git@` or `git@` with `https://` creating the correct edit url. | ||
### α Multiple Docs Directories in Imported Repo (Alpha) | ||
If an imported repo is a monorepo (i.e., has multiple *docs* directories), *multirepo* automatically includes them in the site when `multi_docs` is set to `True`. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters