thang/notes
1
0
Fork 0
mirror of https://github.com/thangisme/notes.git synced 2024-12-22 15:46:30 -05:00
Code Issues Projects Releases Wiki Activity

Update configuration.md

Browse Source
This commit is contained in:
Patrick Marsceill 2020-04-23 22:41:29 -04:00 committed by GitHub
parent eecc51062b
commit 60756a592d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/configuration.md
View File

@ -63,23 +63,27 @@ heading_anchors: true
## Footer content ## Footer content
```yaml ```yaml
# Footer content appears at the bottom of every page's main content # Footer content
# appears at the bottom of every page's main content
footer_content: "Copyright &copy; 2017-2019 Patrick Marsceill. Distributed by an <a href=\"https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt\">MIT license.</a>" footer_content: "Copyright &copy; 2017-2019 Patrick Marsceill. Distributed by an <a href=\"https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt\">MIT license.</a>"
# Footer metadata
show_last_edit_time: true # Footer last edited timestamp
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format last_edit_timestamp: true # show (default) or hide edit time
show_gh_edit_link: true last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub."
gh_edit_repository: "https://github.com/pmarsceill/just-the-docs" # the github URL for your repo gh_edit_repository: "https://github.com/pmarsceill/just-the-docs" # the github URL for your repo
gh_edit_branch: "master" # switch to the branch that your docs is served from gh_edit_branch: "master" # the branch that your docs is served from
gh_edit_view_mode: "tree" # switch to "edit" if you want the user to jump into the editor immediately gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
edit_link_text: "Edit this page on GitHub."
``` ```
* the "page last modified" data will only display if a page has a key called `last_modified_date`, formatted in some readable date format - the "page last modified" data will only display if a page has a key called `last_modified_date`, formatted in some readable date format
* `last_edit_time_format` uses Ruby's DateTime formatter; see examples and more information [at this link.](https://apidock.com/ruby/DateTime/strftime) - `last_edit_time_format` uses Ruby's DateTime formatter; see examples and more information [at this link.](https://apidock.com/ruby/DateTime/strftime)
* `gh_edit_repository` is the URL of the project's GitHub repository - `gh_edit_repository` is the URL of the project's GitHub repository
* `gh_edit_branch` is the branch that the docs site is served from; defaults to `master` - `gh_edit_branch` is the branch that the docs site is served from; defaults to `master`
* `gh_edit_view_mode` is `"tree"` by default, which brings the user to the github page; switch to `"edit"` to bring the user directly into editing mode - `gh_edit_view_mode` is `"tree"` by default, which brings the user to the github page; switch to `"edit"` to bring the user directly into editing mode
## Color scheme ## Color scheme