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

Set different default branch for mkdocs edit #846

Merged
merged 1 commit into from
Mar 9, 2021

Conversation

zoispag
Copy link
Member

@zoispag zoispag commented Mar 8, 2021

From mkdocs documentation:

Note

On a few known hosts (specifically GitHub, Bitbucket and GitLab), the edit_uri is derived from the 'repo_url' and does not need to be set manually. Simply defining a repo_url will automatically populate the edit_uri configs setting.

For example, for a GitHub- or GitLab-hosted repository, the edit_uri would be automatically set as edit/master/docs/ (Note the edit path and master branch).

For a Bitbucket-hosted repository, the equivalent edit_uri would be automatically set as src/default/docs/ (note the src path and default branch).

To use a different URI than the default (for example a different branch), simply set the edit_uri to your desired string. If you do not want any "edit URL link" displayed on your pages, then set edit_uri to an empty string to disable the automatic setting.

Hopefully closes #845

From mkdocs [documentation](https://www.mkdocs.org/user-guide/configuration/#edit_uri):

```
Note

On a few known hosts (specifically GitHub, Bitbucket and GitLab), the edit_uri is derived from the 'repo_url' and does not need to be set manually. Simply defining a repo_url will automatically populate the edit_uri configs setting.

For example, for a GitHub- or GitLab-hosted repository, the edit_uri would be automatically set as edit/master/docs/ (Note the edit path and master branch).

For a Bitbucket-hosted repository, the equivalent edit_uri would be automatically set as src/default/docs/ (note the src path and default branch).

To use a different URI than the default (for example a different branch), simply set the edit_uri to your desired string. If you do not want any "edit URL link" displayed on your pages, then set edit_uri to an empty string to disable the automatic setting.
```
@zoispag zoispag requested a review from simskij March 8, 2021 18:43
@codecov
Copy link

codecov bot commented Mar 8, 2021

Codecov Report

❗ No coverage uploaded for pull request base (main@70c737c). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #846   +/-   ##
=======================================
  Coverage        ?   43.06%           
=======================================
  Files           ?       24           
  Lines           ?     1356           
  Branches        ?        0           
=======================================
  Hits            ?      584           
  Misses          ?      713           
  Partials        ?       59           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 70c737c...8f2af5d. Read the comment docs.

@simskij simskij merged commit 60a6300 into containrrr:main Mar 9, 2021
@zoispag zoispag deleted the patch-1 branch March 9, 2021 13:19
piksel added a commit that referenced this pull request Apr 2, 2021
piksel added a commit that referenced this pull request Apr 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation webpage still based on master branch
2 participants