|
1 | 1 | title: Ocre Docs |
2 | 2 | description: Documentation for the Ocre runtime |
| 3 | +baseurl: "" # the subpath of your site, e.g. /blog |
| 4 | +url: "" # the base hostname & protocol for your site, e.g. http://example.com |
| 5 | +repository: project-ocre/project-ocre.github.io |
3 | 6 | theme: just-the-docs |
4 | 7 |
|
5 | | -url: https://project-ocre.github.io |
| 8 | +### General |
| 9 | +favicon_ico: "favicon.ico" |
| 10 | +# Set a path/url to a logo that will be displayed instead of the title |
| 11 | +logo: "logo.png" |
| 12 | +heading_anchors: true |
| 13 | +enable_copy_code_button: true |
| 14 | +permalink: pretty |
| 15 | + |
| 16 | +### Exclude files from build |
| 17 | +exclude: |
| 18 | + - .DS_Store |
| 19 | + - .git |
| 20 | + - .github |
| 21 | + - .gitignore |
| 22 | + - .jekyll-cache |
| 23 | + - Gemfile |
| 24 | + - Gemfile.lock |
| 25 | + - LICENSE.txt |
| 26 | + - README.md |
| 27 | + - package-lock.json |
| 28 | + |
| 29 | +# Enable or disable the site search |
| 30 | +# Supports true (default) or false |
| 31 | +search_enabled: true |
| 32 | +search: |
| 33 | + # Split pages into sections that can be searched individually |
| 34 | + # Supports 1 - 6, default: 2 |
| 35 | + heading_level: 2 |
| 36 | + # Maximum amount of previews per search result |
| 37 | + # Default: 3 |
| 38 | + previews: 2 |
| 39 | + # Maximum amount of words to display before a matched word in the preview |
| 40 | + # Default: 5 |
| 41 | + preview_words_before: 3 |
| 42 | + # Maximum amount of words to display after a matched word in the preview |
| 43 | + # Default: 10 |
| 44 | + preview_words_after: 3 |
| 45 | + # Set the search token separator |
| 46 | + # Default: /[\s\-/]+/ |
| 47 | + # Example: enable support for hyphenated search words |
| 48 | + tokenizer_separator: /[\s/]+/ |
| 49 | + # Display the relative url in search results |
| 50 | + # Supports true (default) or false |
| 51 | + rel_url: true |
| 52 | + # Enable or disable the search button that appears in the bottom right corner of every page |
| 53 | + # Supports true or false (default) |
| 54 | + button: false |
| 55 | + # Focus the search input by pressing `ctrl + focus_shortcut_key` (or `cmd + focus_shortcut_key` on macOS) |
| 56 | + focus_shortcut_key: "k" |
| 57 | + |
| 58 | +# Callout config |
| 59 | +callouts_level: quiet # or loud |
| 60 | +callouts: |
| 61 | + highlight: |
| 62 | + color: yellow |
| 63 | + important: |
| 64 | + title: Important |
| 65 | + color: blue |
| 66 | + new: |
| 67 | + title: New |
| 68 | + color: green |
| 69 | + note: |
| 70 | + title: Note |
| 71 | + color: purple |
| 72 | + warning: |
| 73 | + title: Warning |
| 74 | + color: red |
| 75 | + |
| 76 | +### Header |
| 77 | +aux_links: |
| 78 | + "Ocre Docs on GitHub": |
| 79 | + - "https://github.com/project-ocre/project-ocre.github.io" |
| 80 | + |
| 81 | +### Footer |
| 82 | +# Back to top link |
| 83 | +back_to_top: true |
| 84 | +back_to_top_text: "Back to top" |
| 85 | + |
| 86 | +# Copyright/license stuff |
| 87 | +footer_content: 'Copyright © 2024 Contributors to Project Ocre, which has been established as <a href="https://lfedge.org/projects/ocre"> Project Ocre a Series of LF Projects</a>, LLC. Distributed by an <a href="https://github.com/project-ocre/project-ocre.github.io/blob/main/LICENSE.txt">Apache 2.0 License.</a>' |
| 88 | + |
| 89 | +#"Edit this page on GitHub" link text |
| 90 | +gh_edit_link: true # show or hide edit this page link |
| 91 | +gh_edit_link_text: "Edit this page on GitHub" |
| 92 | +gh_edit_repository: "https://github.com/project-ocre/project-ocre.github.io" # the github URL for your repo |
| 93 | +gh_edit_branch: "main" # the branch that your docs is served from |
| 94 | +# gh_edit_source: docs # the source that your files originate from |
| 95 | +gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately |
0 commit comments