├── .github └── workflows │ └── pre-commit.yml ├── .pre-commit-config.yaml ├── LICENSE ├── README.md ├── fonts ├── JetBrainsMono-Bold.ttf ├── JetBrainsMono-BoldItalic.ttf ├── JetBrainsMono-Italic.ttf ├── JetBrainsMono-Light.ttf ├── JetBrainsMono-Medium.ttf ├── JetBrainsMono-Regular.ttf ├── JetBrainsMono-Thin.ttf ├── Montserrat-ExtraLight.ttf ├── Montserrat-ExtraLightItalic.ttf ├── Montserrat-Italic.ttf ├── Montserrat-Light.ttf ├── Montserrat-Medium.ttf ├── Montserrat-MediumItalic.ttf ├── Montserrat-Regular.ttf ├── OFL-M.txt ├── OFL-P.txt ├── OFL1.txt ├── Petrona-Light.ttf ├── Petrona-LightItalic.ttf ├── Petrona-Medium.ttf ├── Petrona-MediumItalic.ttf ├── Petrona-Thin.ttf ├── Petrona-ThinItalic.ttf ├── cmunbmr.ttf ├── cmunbtl.ttf ├── cmunbto.ttf ├── droid-sans-fallback.ttf ├── mplus-1mn-bold.ttf ├── mplus-1mn-light.ttf ├── mplus-1mn-medium.ttf ├── mplus-1mn-regular.ttf ├── mplus-1mn-thin.ttf └── mplus-1p-regular-fallback.ttf ├── global-config.adoc ├── images ├── draft.png ├── risc-v_logo.png └── risc-v_logo.svg └── themes └── riscv-pdf.yml /.github/workflows/pre-commit.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: pre-commit 3 | 4 | on: 5 | pull_request: 6 | push: 7 | branches: [main] 8 | 9 | jobs: 10 | pre-commit: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v3 14 | - uses: actions/setup-python@v3 15 | - uses: pre-commit/action@v3.0.0 16 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | repos: 3 | - repo: https://github.com/pre-commit/pre-commit-hooks 4 | rev: v4.5.0 5 | hooks: 6 | - id: check-symlinks 7 | - id: check-yaml 8 | - id: end-of-file-fixer 9 | exclude: \.svg$ 10 | - id: trailing-whitespace 11 | args: [--markdown-linebreak-ext=md] 12 | exclude: \.svg$ 13 | 14 | - repo: https://github.com/jumanjihouse/pre-commit-hook-yamlfmt 15 | rev: 0.2.3 16 | hooks: 17 | - id: yamlfmt 18 | args: [--mapping, '2', --sequence, '4', --offset, '2'] 19 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Attribution 4.0 International 2 | 3 | ======================================================================= 4 | 5 | Creative Commons Corporation ("Creative Commons") is not a law firm and 6 | does not provide legal services or legal advice. Distribution of 7 | Creative Commons public licenses does not create a lawyer-client or 8 | other relationship. Creative Commons makes its licenses and related 9 | information available on an "as-is" basis. Creative Commons gives no 10 | warranties regarding its licenses, any material licensed under their 11 | terms and conditions, or any related information. Creative Commons 12 | disclaims all liability for damages resulting from their use to the 13 | fullest extent possible. 14 | 15 | Using Creative Commons Public Licenses 16 | 17 | Creative Commons public licenses provide a standard set of terms and 18 | conditions that creators and other rights holders may use to share 19 | original works of authorship and other material subject to copyright 20 | and certain other rights specified in the public license below. The 21 | following considerations are for informational purposes only, are not 22 | exhaustive, and do not form part of our licenses. 23 | 24 | Considerations for licensors: Our public licenses are 25 | intended for use by those authorized to give the public 26 | permission to use material in ways otherwise restricted by 27 | copyright and certain other rights. Our licenses are 28 | irrevocable. Licensors should read and understand the terms 29 | and conditions of the license they choose before applying it. 30 | Licensors should also secure all rights necessary before 31 | applying our licenses so that the public can reuse the 32 | material as expected. Licensors should clearly mark any 33 | material not subject to the license. This includes other CC- 34 | licensed material, or material used under an exception or 35 | limitation to copyright. More considerations for licensors: 36 | wiki.creativecommons.org/Considerations_for_licensors 37 | 38 | Considerations for the public: By using one of our public 39 | licenses, a licensor grants the public permission to use the 40 | licensed material under specified terms and conditions. If 41 | the licensor's permission is not necessary for any reason--for 42 | example, because of any applicable exception or limitation to 43 | copyright--then that use is not regulated by the license. Our 44 | licenses grant only permissions under copyright and certain 45 | other rights that a licensor has authority to grant. Use of 46 | the licensed material may still be restricted for other 47 | reasons, including because others have copyright or other 48 | rights in the material. A licensor may make special requests, 49 | such as asking that all changes be marked or described. 50 | Although not required by our licenses, you are encouraged to 51 | respect those requests where reasonable. More_considerations 52 | for the public: 53 | wiki.creativecommons.org/Considerations_for_licensees 54 | 55 | ======================================================================= 56 | 57 | Creative Commons Attribution 4.0 International Public License 58 | 59 | By exercising the Licensed Rights (defined below), You accept and agree 60 | to be bound by the terms and conditions of this Creative Commons 61 | Attribution 4.0 International Public License ("Public License"). To the 62 | extent this Public License may be interpreted as a contract, You are 63 | granted the Licensed Rights in consideration of Your acceptance of 64 | these terms and conditions, and the Licensor grants You such rights in 65 | consideration of benefits the Licensor receives from making the 66 | Licensed Material available under these terms and conditions. 67 | 68 | 69 | Section 1 -- Definitions. 70 | 71 | a. Adapted Material means material subject to Copyright and Similar 72 | Rights that is derived from or based upon the Licensed Material 73 | and in which the Licensed Material is translated, altered, 74 | arranged, transformed, or otherwise modified in a manner requiring 75 | permission under the Copyright and Similar Rights held by the 76 | Licensor. For purposes of this Public License, where the Licensed 77 | Material is a musical work, performance, or sound recording, 78 | Adapted Material is always produced where the Licensed Material is 79 | synched in timed relation with a moving image. 80 | 81 | b. Adapter's License means the license You apply to Your Copyright 82 | and Similar Rights in Your contributions to Adapted Material in 83 | accordance with the terms and conditions of this Public License. 84 | 85 | c. Copyright and Similar Rights means copyright and/or similar rights 86 | closely related to copyright including, without limitation, 87 | performance, broadcast, sound recording, and Sui Generis Database 88 | Rights, without regard to how the rights are labeled or 89 | categorized. For purposes of this Public License, the rights 90 | specified in Section 2(b)(1)-(2) are not Copyright and Similar 91 | Rights. 92 | 93 | d. Effective Technological Measures means those measures that, in the 94 | absence of proper authority, may not be circumvented under laws 95 | fulfilling obligations under Article 11 of the WIPO Copyright 96 | Treaty adopted on December 20, 1996, and/or similar international 97 | agreements. 98 | 99 | e. Exceptions and Limitations means fair use, fair dealing, and/or 100 | any other exception or limitation to Copyright and Similar Rights 101 | that applies to Your use of the Licensed Material. 102 | 103 | f. Licensed Material means the artistic or literary work, database, 104 | or other material to which the Licensor applied this Public 105 | License. 106 | 107 | g. Licensed Rights means the rights granted to You subject to the 108 | terms and conditions of this Public License, which are limited to 109 | all Copyright and Similar Rights that apply to Your use of the 110 | Licensed Material and that the Licensor has authority to license. 111 | 112 | h. Licensor means the individual(s) or entity(ies) granting rights 113 | under this Public License. 114 | 115 | i. Share means to provide material to the public by any means or 116 | process that requires permission under the Licensed Rights, such 117 | as reproduction, public display, public performance, distribution, 118 | dissemination, communication, or importation, and to make material 119 | available to the public including in ways that members of the 120 | public may access the material from a place and at a time 121 | individually chosen by them. 122 | 123 | j. Sui Generis Database Rights means rights other than copyright 124 | resulting from Directive 96/9/EC of the European Parliament and of 125 | the Council of 11 March 1996 on the legal protection of databases, 126 | as amended and/or succeeded, as well as other essentially 127 | equivalent rights anywhere in the world. 128 | 129 | k. You means the individual or entity exercising the Licensed Rights 130 | under this Public License. Your has a corresponding meaning. 131 | 132 | 133 | Section 2 -- Scope. 134 | 135 | a. License grant. 136 | 137 | 1. Subject to the terms and conditions of this Public License, 138 | the Licensor hereby grants You a worldwide, royalty-free, 139 | non-sublicensable, non-exclusive, irrevocable license to 140 | exercise the Licensed Rights in the Licensed Material to: 141 | 142 | a. reproduce and Share the Licensed Material, in whole or 143 | in part; and 144 | 145 | b. produce, reproduce, and Share Adapted Material. 146 | 147 | 2. Exceptions and Limitations. For the avoidance of doubt, where 148 | Exceptions and Limitations apply to Your use, this Public 149 | License does not apply, and You do not need to comply with 150 | its terms and conditions. 151 | 152 | 3. Term. The term of this Public License is specified in Section 153 | 6(a). 154 | 155 | 4. Media and formats; technical modifications allowed. The 156 | Licensor authorizes You to exercise the Licensed Rights in 157 | all media and formats whether now known or hereafter created, 158 | and to make technical modifications necessary to do so. The 159 | Licensor waives and/or agrees not to assert any right or 160 | authority to forbid You from making technical modifications 161 | necessary to exercise the Licensed Rights, including 162 | technical modifications necessary to circumvent Effective 163 | Technological Measures. For purposes of this Public License, 164 | simply making modifications authorized by this Section 2(a) 165 | (4) never produces Adapted Material. 166 | 167 | 5. Downstream recipients. 168 | 169 | a. Offer from the Licensor -- Licensed Material. Every 170 | recipient of the Licensed Material automatically 171 | receives an offer from the Licensor to exercise the 172 | Licensed Rights under the terms and conditions of this 173 | Public License. 174 | 175 | b. No downstream restrictions. You may not offer or impose 176 | any additional or different terms or conditions on, or 177 | apply any Effective Technological Measures to, the 178 | Licensed Material if doing so restricts exercise of the 179 | Licensed Rights by any recipient of the Licensed 180 | Material. 181 | 182 | 6. No endorsement. Nothing in this Public License constitutes or 183 | may be construed as permission to assert or imply that You 184 | are, or that Your use of the Licensed Material is, connected 185 | with, or sponsored, endorsed, or granted official status by, 186 | the Licensor or others designated to receive attribution as 187 | provided in Section 3(a)(1)(A)(i). 188 | 189 | b. Other rights. 190 | 191 | 1. Moral rights, such as the right of integrity, are not 192 | licensed under this Public License, nor are publicity, 193 | privacy, and/or other similar personality rights; however, to 194 | the extent possible, the Licensor waives and/or agrees not to 195 | assert any such rights held by the Licensor to the limited 196 | extent necessary to allow You to exercise the Licensed 197 | Rights, but not otherwise. 198 | 199 | 2. Patent and trademark rights are not licensed under this 200 | Public License. 201 | 202 | 3. To the extent possible, the Licensor waives any right to 203 | collect royalties from You for the exercise of the Licensed 204 | Rights, whether directly or through a collecting society 205 | under any voluntary or waivable statutory or compulsory 206 | licensing scheme. In all other cases the Licensor expressly 207 | reserves any right to collect such royalties. 208 | 209 | 210 | Section 3 -- License Conditions. 211 | 212 | Your exercise of the Licensed Rights is expressly made subject to the 213 | following conditions. 214 | 215 | a. Attribution. 216 | 217 | 1. If You Share the Licensed Material (including in modified 218 | form), You must: 219 | 220 | a. retain the following if it is supplied by the Licensor 221 | with the Licensed Material: 222 | 223 | i. identification of the creator(s) of the Licensed 224 | Material and any others designated to receive 225 | attribution, in any reasonable manner requested by 226 | the Licensor (including by pseudonym if 227 | designated); 228 | 229 | ii. a copyright notice; 230 | 231 | iii. a notice that refers to this Public License; 232 | 233 | iv. a notice that refers to the disclaimer of 234 | warranties; 235 | 236 | v. a URI or hyperlink to the Licensed Material to the 237 | extent reasonably practicable; 238 | 239 | b. indicate if You modified the Licensed Material and 240 | retain an indication of any previous modifications; and 241 | 242 | c. indicate the Licensed Material is licensed under this 243 | Public License, and include the text of, or the URI or 244 | hyperlink to, this Public License. 245 | 246 | 2. You may satisfy the conditions in Section 3(a)(1) in any 247 | reasonable manner based on the medium, means, and context in 248 | which You Share the Licensed Material. For example, it may be 249 | reasonable to satisfy the conditions by providing a URI or 250 | hyperlink to a resource that includes the required 251 | information. 252 | 253 | 3. If requested by the Licensor, You must remove any of the 254 | information required by Section 3(a)(1)(A) to the extent 255 | reasonably practicable. 256 | 257 | 4. If You Share Adapted Material You produce, the Adapter's 258 | License You apply must not prevent recipients of the Adapted 259 | Material from complying with this Public License. 260 | 261 | 262 | Section 4 -- Sui Generis Database Rights. 263 | 264 | Where the Licensed Rights include Sui Generis Database Rights that 265 | apply to Your use of the Licensed Material: 266 | 267 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right 268 | to extract, reuse, reproduce, and Share all or a substantial 269 | portion of the contents of the database; 270 | 271 | b. if You include all or a substantial portion of the database 272 | contents in a database in which You have Sui Generis Database 273 | Rights, then the database in which You have Sui Generis Database 274 | Rights (but not its individual contents) is Adapted Material; and 275 | 276 | c. You must comply with the conditions in Section 3(a) if You Share 277 | all or a substantial portion of the contents of the database. 278 | 279 | For the avoidance of doubt, this Section 4 supplements and does not 280 | replace Your obligations under this Public License where the Licensed 281 | Rights include other Copyright and Similar Rights. 282 | 283 | 284 | Section 5 -- Disclaimer of Warranties and Limitation of Liability. 285 | 286 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE 287 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS 288 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF 289 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, 290 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, 291 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR 292 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, 293 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT 294 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT 295 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. 296 | 297 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE 298 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, 299 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, 300 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, 301 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR 302 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN 303 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR 304 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR 305 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. 306 | 307 | c. The disclaimer of warranties and limitation of liability provided 308 | above shall be interpreted in a manner that, to the extent 309 | possible, most closely approximates an absolute disclaimer and 310 | waiver of all liability. 311 | 312 | 313 | Section 6 -- Term and Termination. 314 | 315 | a. This Public License applies for the term of the Copyright and 316 | Similar Rights licensed here. However, if You fail to comply with 317 | this Public License, then Your rights under this Public License 318 | terminate automatically. 319 | 320 | b. Where Your right to use the Licensed Material has terminated under 321 | Section 6(a), it reinstates: 322 | 323 | 1. automatically as of the date the violation is cured, provided 324 | it is cured within 30 days of Your discovery of the 325 | violation; or 326 | 327 | 2. upon express reinstatement by the Licensor. 328 | 329 | For the avoidance of doubt, this Section 6(b) does not affect any 330 | right the Licensor may have to seek remedies for Your violations 331 | of this Public License. 332 | 333 | c. For the avoidance of doubt, the Licensor may also offer the 334 | Licensed Material under separate terms or conditions or stop 335 | distributing the Licensed Material at any time; however, doing so 336 | will not terminate this Public License. 337 | 338 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public 339 | License. 340 | 341 | 342 | Section 7 -- Other Terms and Conditions. 343 | 344 | a. The Licensor shall not be bound by any additional or different 345 | terms or conditions communicated by You unless expressly agreed. 346 | 347 | b. Any arrangements, understandings, or agreements regarding the 348 | Licensed Material not stated herein are separate from and 349 | independent of the terms and conditions of this Public License. 350 | 351 | 352 | Section 8 -- Interpretation. 353 | 354 | a. For the avoidance of doubt, this Public License does not, and 355 | shall not be interpreted to, reduce, limit, restrict, or impose 356 | conditions on any use of the Licensed Material that could lawfully 357 | be made without permission under this Public License. 358 | 359 | b. To the extent possible, if any provision of this Public License is 360 | deemed unenforceable, it shall be automatically reformed to the 361 | minimum extent necessary to make it enforceable. If the provision 362 | cannot be reformed, it shall be severed from this Public License 363 | without affecting the enforceability of the remaining terms and 364 | conditions. 365 | 366 | c. No term or condition of this Public License will be waived and no 367 | failure to comply consented to unless expressly agreed to by the 368 | Licensor. 369 | 370 | d. Nothing in this Public License constitutes or may be interpreted 371 | as a limitation upon, or waiver of, any privileges and immunities 372 | that apply to the Licensor or You, including from the legal 373 | processes of any jurisdiction or authority. 374 | 375 | 376 | ======================================================================= 377 | 378 | Creative Commons is not a party to its public 379 | licenses. Notwithstanding, Creative Commons may elect to apply one of 380 | its public licenses to material it publishes and in those instances 381 | will be considered the “Licensor.” The text of the Creative Commons 382 | public licenses is dedicated to the public domain under the CC0 Public 383 | Domain Dedication. Except for the limited purpose of indicating that 384 | material is shared under a Creative Commons public license or as 385 | otherwise permitted by the Creative Commons policies published at 386 | creativecommons.org/policies, Creative Commons does not authorize the 387 | use of the trademark "Creative Commons" or any other trademark or logo 388 | of Creative Commons without its prior written consent including, 389 | without limitation, in connection with any unauthorized modifications 390 | to any of its public licenses or any other arrangements, 391 | understandings, or agreements concerning use of licensed material. For 392 | the avoidance of doubt, this paragraph does not form part of the 393 | public licenses. 394 | 395 | Creative Commons may be contacted at creativecommons.org. 396 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # RISC-V Documentation Resources 2 | This repository (repo) contains the resources needed to build docs with the RISC-V themes, fonts, and logos. 3 | 4 | Specification repos created after January 2022 are generally created from the 5 | [docs-spec-template](https://github.com/riscv/docs-spec-template) repository and will 6 | have all the requisites parts included in a basic document. 7 | 8 | Older repos can be updated with 3 basic steps: 9 | 10 | 1. Update the directory structure to reference the docs-resources, (this) repository. 11 | 2. Update the main AsciiDoc source file to include new variables needed for build. 12 | 3. Update the `Makefile` to build using the new resources. 13 | 14 | ## Updating the directory structure 15 | The three main directories in this repo contain various components of the RISC-V documentation 16 | template. The `docs-resources/images/` directory has artwork like the RISC-V logo. The `docs-resources/fonts/` 17 | directory contains the necessary fonts. And, the `docs-resources/themes/` directory contains the YAML file 18 | for configuring the document. 19 | 20 | In order to be able to link a repo with this project, you must use 21 | [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules). While there are many ways to do this, 22 | we will take the simplest approach and use the submodule defaults, 23 | placing a `docs-resources/` directory in the repo head. This can be accomplished by executing 24 | the following command in the top project directory (assuming http access): 25 | 26 | ``` 27 | git submodule add https://github.com/riscv/docs-resources.git 28 | ``` 29 | 30 | This command will create a `docs-resources/` directory when completed. Additionally, the `git status` 31 | command should show new files of `docs-resources` and either a new or modified file of `.gitmodules` 32 | depending upon whether Git Submodules are already in use in the project. 33 | 34 | **Note:** The use of Submodules creates a “link” in Git between projects that are tied to 35 | specific commit id. This provides “safety” for the including projects by making sure that 36 | they don’t inadvertently get broken. However, it creates an additional maintenance responsibility 37 | to intermittently rebase the link and verify that nothing has been broken. Project maintainers need to 38 | understand this and plan accordingly. 39 | 40 | ## Updating the main AsciiDoc source file 41 | From the `Makefile`, find the main AsciiDoc file that is used to build the project. 42 | It usually has the same base name as the .pdf which is generated. 43 | 44 | Open this file and ensure that the following variables are added to top the document: 45 | 46 | ``` 47 | // These variables need customization for the specification 48 | :description: Short, text description of spec… 49 | :revdate: Month day, Year 50 | :revnumber: X.Y.Z 51 | :revremark: This document is in Development state. Change should be expected. 52 | 53 | // These variables should not require customization 54 | :company: RISC-V 55 | :url-riscv: http://riscv.org 56 | :doctype: book 57 | :preface-title: Preamble 58 | :colophon: 59 | :appendix-caption: Appendix 60 | :title-logo-image: image:docs-resources/images/risc-v_logo.svg[pdfwidth=3.25in,align=center] 61 | // Settings: 62 | :experimental: 63 | :reproducible: 64 | :WaveDromEditorApp: wavedrom-cli 65 | :icons: font 66 | :lang: en 67 | :listing-caption: Listing 68 | :sectnums: 69 | :sectnumlevels: 5 70 | :toclevels: 5 71 | :toc: left 72 | :source-highlighter: pygments 73 | ifdef::backend-pdf[] 74 | :source-highlighter: coderay 75 | endif::[] 76 | :data-uri: 77 | :hide-uri-scheme: 78 | :stem: latexmath 79 | :footnote: 80 | :xrefstyle: short 81 | ``` 82 | 83 | The variables in the first section above should be visited and updated as appropriate. 84 | Additionally, any variables which already exist in the document should be evaluated 85 | for the better value, which most likely is the template value specified above for anything 86 | in the document. 87 | 88 | ## Updating the `Makefile` 89 | Typical build invocations for basic AsciiDoc builds look like this: 90 | 91 | ``` 92 | %.pdf: %.adoc 93 | asciidoctor-pdf $< 94 | ``` 95 | 96 | To build using the RISC-V template, this statement needs to look like this: 97 | ``` 98 | %.pdf: %.adoc 99 | asciidoctor-pdf \ 100 | -a toc \ 101 | -a compress \ 102 | -a pdf-theme=docs-resources/themes/riscv-pdf.yml \ 103 | -a pdf-fontsdir=docs-resources/fonts \ 104 | -o $@ $< 105 | ``` 106 | 107 | **Note:** if you want to include a bibliography, you can include a 108 | “-r asciidoctor-bibtex” statement. Likewise, to use various diagramming 109 | capabilities, you can include “-r asciidoctor-diagram”. 110 | 111 | ## Additional items to consider for the document 112 | 113 | ### License and copyright statements 114 | While making updates to documents, ensure that a License statement is included near the front 115 | of the document, preferably in the Preamble. The Asciidoc text for this should look something like this: 116 | 117 | ``` 118 | [NOTE] 119 | .Copyright and licensure: 120 | ==== 121 | This work is licensed under a 122 | link:http://creativecommons.org/licenses/by/4.0/[Creative Commons Attribution 4.0 International License]. 123 | 124 | This work is Copyright 2022 by RISC-V International. 125 | ==== 126 | ``` 127 | 128 | ### Document state markings 129 | Document state should be reflected in the `:revremark:` variable and be contained in 130 | an in-document admonition statement near the front of the document (Preface or Preamble). 131 | 132 | The recommended values for `:revremark:` and the front matter admonition based on the document 133 | state are as follows: 134 | 135 | * For **Discussion Document** state, use: 136 | * `:revremark: This document is in Discussion state. Change should be expected.` 137 | * Formal admonition text: 138 | ``` 139 | [WARNING] 140 | .This document is in the link:https://lf-riscv.atlassian.net/wiki/display/HOME/Specification+States[Discussion state] 141 | ==== 142 | Assume everything can change. This document is not complete yet and was created only 143 | for the purpose of conversation outside of the document. 144 | ==== 145 | ``` 146 | * For **Development** state, use: 147 | * `:revremark: This document is in Development state. Change should be expected.` 148 | * Formal admonition text: 149 | ``` 150 | [WARNING] 151 | .This document is in the link:https://lf-riscv.atlassian.net/wiki/display/HOME/Specification+States[Development state] 152 | ==== 153 | Assume everything can change. This draft specification will change before being accepted 154 | as standard, so implementations made to this draft specification will likely not conform 155 | to the future standard. 156 | ==== 157 | ``` 158 | * For **Stable** state, use: 159 | * `:revremark: This document is in Stable state. Assume it may change.` 160 | * Formal admonition text: 161 | ``` 162 | [WARNING] 163 | .This document is in the link:https://lf-riscv.atlassian.net/wiki/display/HOME/Specification+States[Stable state] 164 | ==== 165 | Assume anything could still change, but limited change should be expected. 166 | ==== 167 | ``` 168 | * For **Frozen** state, use: 169 | * `:revremark: This document is in Frozen state. Change is extremely unlikely.` 170 | * Formal admonition text: 171 | ``` 172 | [WARNING] 173 | .This document is in the link:https://lf-riscv.atlassian.net/wiki/display/HOME/Specification+States[Frozen state] 174 | ==== 175 | Change is extremely unlikely. A high threshold will be used, and a change 176 | will only occur because of some truly critical issue being identified during 177 | the public review cycle. Any other desired or needed changes can be the subject 178 | of a follow-on new extension. 179 | ==== 180 | ``` 181 | * For **Ratified** state, use: 182 | * `:revremark: This document is in Ratified state. No changes are allowed.` 183 | * Formal admonition text: 184 | ``` 185 | [WARNING] 186 | .This document is in the link:https://lf-riscv.atlassian.net/wiki/display/HOME/Specification+States[Ratified state] 187 | ==== 188 | No changes are allowed. Any desired or needed changes can be the subject 189 | of a follow-on new extension. Ratified extensions are never revised. 190 | ==== 191 | ``` 192 | 193 | # Additional information 194 | For additional information, see the [docs-dev-guide/example.pdf](https://github.com/riscv/docs-dev-guide/blob/main/example.pdf) or reach out to 195 | help@riscv.org. 196 | -------------------------------------------------------------------------------- /fonts/JetBrainsMono-Bold.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/JetBrainsMono-Bold.ttf -------------------------------------------------------------------------------- /fonts/JetBrainsMono-BoldItalic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/JetBrainsMono-BoldItalic.ttf -------------------------------------------------------------------------------- /fonts/JetBrainsMono-Italic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/JetBrainsMono-Italic.ttf -------------------------------------------------------------------------------- /fonts/JetBrainsMono-Light.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/JetBrainsMono-Light.ttf -------------------------------------------------------------------------------- /fonts/JetBrainsMono-Medium.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/JetBrainsMono-Medium.ttf -------------------------------------------------------------------------------- /fonts/JetBrainsMono-Regular.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/JetBrainsMono-Regular.ttf -------------------------------------------------------------------------------- /fonts/JetBrainsMono-Thin.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/JetBrainsMono-Thin.ttf -------------------------------------------------------------------------------- /fonts/Montserrat-ExtraLight.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/Montserrat-ExtraLight.ttf -------------------------------------------------------------------------------- /fonts/Montserrat-ExtraLightItalic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/Montserrat-ExtraLightItalic.ttf -------------------------------------------------------------------------------- /fonts/Montserrat-Italic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/Montserrat-Italic.ttf -------------------------------------------------------------------------------- /fonts/Montserrat-Light.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/Montserrat-Light.ttf -------------------------------------------------------------------------------- /fonts/Montserrat-Medium.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/Montserrat-Medium.ttf -------------------------------------------------------------------------------- /fonts/Montserrat-MediumItalic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/Montserrat-MediumItalic.ttf -------------------------------------------------------------------------------- /fonts/Montserrat-Regular.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/Montserrat-Regular.ttf -------------------------------------------------------------------------------- /fonts/OFL-M.txt: -------------------------------------------------------------------------------- 1 | Copyright 2011 The Montserrat Project Authors (https://github.com/JulietaUla/Montserrat) 2 | 3 | This Font Software is licensed under the SIL Open Font License, Version 1.1. 4 | This license is copied below, and is also available with a FAQ at: 5 | http://scripts.sil.org/OFL 6 | 7 | 8 | ----------------------------------------------------------- 9 | SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 10 | ----------------------------------------------------------- 11 | 12 | PREAMBLE 13 | The goals of the Open Font License (OFL) are to stimulate worldwide 14 | development of collaborative font projects, to support the font creation 15 | efforts of academic and linguistic communities, and to provide a free and 16 | open framework in which fonts may be shared and improved in partnership 17 | with others. 18 | 19 | The OFL allows the licensed fonts to be used, studied, modified and 20 | redistributed freely as long as they are not sold by themselves. The 21 | fonts, including any derivative works, can be bundled, embedded, 22 | redistributed and/or sold with any software provided that any reserved 23 | names are not used by derivative works. The fonts and derivatives, 24 | however, cannot be released under any other type of license. The 25 | requirement for fonts to remain under this license does not apply 26 | to any document created using the fonts or their derivatives. 27 | 28 | DEFINITIONS 29 | "Font Software" refers to the set of files released by the Copyright 30 | Holder(s) under this license and clearly marked as such. This may 31 | include source files, build scripts and documentation. 32 | 33 | "Reserved Font Name" refers to any names specified as such after the 34 | copyright statement(s). 35 | 36 | "Original Version" refers to the collection of Font Software components as 37 | distributed by the Copyright Holder(s). 38 | 39 | "Modified Version" refers to any derivative made by adding to, deleting, 40 | or substituting -- in part or in whole -- any of the components of the 41 | Original Version, by changing formats or by porting the Font Software to a 42 | new environment. 43 | 44 | "Author" refers to any designer, engineer, programmer, technical 45 | writer or other person who contributed to the Font Software. 46 | 47 | PERMISSION & CONDITIONS 48 | Permission is hereby granted, free of charge, to any person obtaining 49 | a copy of the Font Software, to use, study, copy, merge, embed, modify, 50 | redistribute, and sell modified and unmodified copies of the Font 51 | Software, subject to the following conditions: 52 | 53 | 1) Neither the Font Software nor any of its individual components, 54 | in Original or Modified Versions, may be sold by itself. 55 | 56 | 2) Original or Modified Versions of the Font Software may be bundled, 57 | redistributed and/or sold with any software, provided that each copy 58 | contains the above copyright notice and this license. These can be 59 | included either as stand-alone text files, human-readable headers or 60 | in the appropriate machine-readable metadata fields within text or 61 | binary files as long as those fields can be easily viewed by the user. 62 | 63 | 3) No Modified Version of the Font Software may use the Reserved Font 64 | Name(s) unless explicit written permission is granted by the corresponding 65 | Copyright Holder. This restriction only applies to the primary font name as 66 | presented to the users. 67 | 68 | 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font 69 | Software shall not be used to promote, endorse or advertise any 70 | Modified Version, except to acknowledge the contribution(s) of the 71 | Copyright Holder(s) and the Author(s) or with their explicit written 72 | permission. 73 | 74 | 5) The Font Software, modified or unmodified, in part or in whole, 75 | must be distributed entirely under this license, and must not be 76 | distributed under any other license. The requirement for fonts to 77 | remain under this license does not apply to any document created 78 | using the Font Software. 79 | 80 | TERMINATION 81 | This license becomes null and void if any of the above conditions are 82 | not met. 83 | 84 | DISCLAIMER 85 | THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 86 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF 87 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT 88 | OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE 89 | COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 90 | INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL 91 | DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 92 | FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM 93 | OTHER DEALINGS IN THE FONT SOFTWARE. 94 | -------------------------------------------------------------------------------- /fonts/OFL-P.txt: -------------------------------------------------------------------------------- 1 | Copyright 2019 The Petrona Project Authors (https://github.com/RingoSeeber/Petrona) 2 | 3 | This Font Software is licensed under the SIL Open Font License, Version 1.1. 4 | This license is copied below, and is also available with a FAQ at: 5 | http://scripts.sil.org/OFL 6 | 7 | 8 | ----------------------------------------------------------- 9 | SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 10 | ----------------------------------------------------------- 11 | 12 | PREAMBLE 13 | The goals of the Open Font License (OFL) are to stimulate worldwide 14 | development of collaborative font projects, to support the font creation 15 | efforts of academic and linguistic communities, and to provide a free and 16 | open framework in which fonts may be shared and improved in partnership 17 | with others. 18 | 19 | The OFL allows the licensed fonts to be used, studied, modified and 20 | redistributed freely as long as they are not sold by themselves. The 21 | fonts, including any derivative works, can be bundled, embedded, 22 | redistributed and/or sold with any software provided that any reserved 23 | names are not used by derivative works. The fonts and derivatives, 24 | however, cannot be released under any other type of license. The 25 | requirement for fonts to remain under this license does not apply 26 | to any document created using the fonts or their derivatives. 27 | 28 | DEFINITIONS 29 | "Font Software" refers to the set of files released by the Copyright 30 | Holder(s) under this license and clearly marked as such. This may 31 | include source files, build scripts and documentation. 32 | 33 | "Reserved Font Name" refers to any names specified as such after the 34 | copyright statement(s). 35 | 36 | "Original Version" refers to the collection of Font Software components as 37 | distributed by the Copyright Holder(s). 38 | 39 | "Modified Version" refers to any derivative made by adding to, deleting, 40 | or substituting -- in part or in whole -- any of the components of the 41 | Original Version, by changing formats or by porting the Font Software to a 42 | new environment. 43 | 44 | "Author" refers to any designer, engineer, programmer, technical 45 | writer or other person who contributed to the Font Software. 46 | 47 | PERMISSION & CONDITIONS 48 | Permission is hereby granted, free of charge, to any person obtaining 49 | a copy of the Font Software, to use, study, copy, merge, embed, modify, 50 | redistribute, and sell modified and unmodified copies of the Font 51 | Software, subject to the following conditions: 52 | 53 | 1) Neither the Font Software nor any of its individual components, 54 | in Original or Modified Versions, may be sold by itself. 55 | 56 | 2) Original or Modified Versions of the Font Software may be bundled, 57 | redistributed and/or sold with any software, provided that each copy 58 | contains the above copyright notice and this license. These can be 59 | included either as stand-alone text files, human-readable headers or 60 | in the appropriate machine-readable metadata fields within text or 61 | binary files as long as those fields can be easily viewed by the user. 62 | 63 | 3) No Modified Version of the Font Software may use the Reserved Font 64 | Name(s) unless explicit written permission is granted by the corresponding 65 | Copyright Holder. This restriction only applies to the primary font name as 66 | presented to the users. 67 | 68 | 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font 69 | Software shall not be used to promote, endorse or advertise any 70 | Modified Version, except to acknowledge the contribution(s) of the 71 | Copyright Holder(s) and the Author(s) or with their explicit written 72 | permission. 73 | 74 | 5) The Font Software, modified or unmodified, in part or in whole, 75 | must be distributed entirely under this license, and must not be 76 | distributed under any other license. The requirement for fonts to 77 | remain under this license does not apply to any document created 78 | using the Font Software. 79 | 80 | TERMINATION 81 | This license becomes null and void if any of the above conditions are 82 | not met. 83 | 84 | DISCLAIMER 85 | THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 86 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF 87 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT 88 | OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE 89 | COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 90 | INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL 91 | DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 92 | FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM 93 | OTHER DEALINGS IN THE FONT SOFTWARE. 94 | -------------------------------------------------------------------------------- /fonts/OFL1.txt: -------------------------------------------------------------------------------- 1 | Attribution 4.0 International 2 | 3 | ======================================================================= 4 | 5 | Creative Commons Corporation ("Creative Commons") is not a law firm and 6 | does not provide legal services or legal advice. Distribution of 7 | Creative Commons public licenses does not create a lawyer-client or 8 | other relationship. Creative Commons makes its licenses and related 9 | information available on an "as-is" basis. Creative Commons gives no 10 | warranties regarding its licenses, any material licensed under their 11 | terms and conditions, or any related information. Creative Commons 12 | disclaims all liability for damages resulting from their use to the 13 | fullest extent possible. 14 | 15 | Using Creative Commons Public Licenses 16 | 17 | Creative Commons public licenses provide a standard set of terms and 18 | conditions that creators and other rights holders may use to share 19 | original works of authorship and other material subject to copyright 20 | and certain other rights specified in the public license below. The 21 | following considerations are for informational purposes only, are not 22 | exhaustive, and do not form part of our licenses. 23 | 24 | Considerations for licensors: Our public licenses are 25 | intended for use by those authorized to give the public 26 | permission to use material in ways otherwise restricted by 27 | copyright and certain other rights. Our licenses are 28 | irrevocable. Licensors should read and understand the terms 29 | and conditions of the license they choose before applying it. 30 | Licensors should also secure all rights necessary before 31 | applying our licenses so that the public can reuse the 32 | material as expected. Licensors should clearly mark any 33 | material not subject to the license. This includes other CC- 34 | licensed material, or material used under an exception or 35 | limitation to copyright. More considerations for licensors: 36 | wiki.creativecommons.org/Considerations_for_licensors 37 | 38 | Considerations for the public: By using one of our public 39 | licenses, a licensor grants the public permission to use the 40 | licensed material under specified terms and conditions. If 41 | the licensor's permission is not necessary for any reason--for 42 | example, because of any applicable exception or limitation to 43 | copyright--then that use is not regulated by the license. Our 44 | licenses grant only permissions under copyright and certain 45 | other rights that a licensor has authority to grant. Use of 46 | the licensed material may still be restricted for other 47 | reasons, including because others have copyright or other 48 | rights in the material. A licensor may make special requests, 49 | such as asking that all changes be marked or described. 50 | Although not required by our licenses, you are encouraged to 51 | respect those requests where reasonable. More_considerations 52 | for the public: 53 | wiki.creativecommons.org/Considerations_for_licensees 54 | 55 | ======================================================================= 56 | 57 | Creative Commons Attribution 4.0 International Public License 58 | 59 | By exercising the Licensed Rights (defined below), You accept and agree 60 | to be bound by the terms and conditions of this Creative Commons 61 | Attribution 4.0 International Public License ("Public License"). To the 62 | extent this Public License may be interpreted as a contract, You are 63 | granted the Licensed Rights in consideration of Your acceptance of 64 | these terms and conditions, and the Licensor grants You such rights in 65 | consideration of benefits the Licensor receives from making the 66 | Licensed Material available under these terms and conditions. 67 | 68 | 69 | Section 1 -- Definitions. 70 | 71 | a. Adapted Material means material subject to Copyright and Similar 72 | Rights that is derived from or based upon the Licensed Material 73 | and in which the Licensed Material is translated, altered, 74 | arranged, transformed, or otherwise modified in a manner requiring 75 | permission under the Copyright and Similar Rights held by the 76 | Licensor. For purposes of this Public License, where the Licensed 77 | Material is a musical work, performance, or sound recording, 78 | Adapted Material is always produced where the Licensed Material is 79 | synched in timed relation with a moving image. 80 | 81 | b. Adapter's License means the license You apply to Your Copyright 82 | and Similar Rights in Your contributions to Adapted Material in 83 | accordance with the terms and conditions of this Public License. 84 | 85 | c. Copyright and Similar Rights means copyright and/or similar rights 86 | closely related to copyright including, without limitation, 87 | performance, broadcast, sound recording, and Sui Generis Database 88 | Rights, without regard to how the rights are labeled or 89 | categorized. For purposes of this Public License, the rights 90 | specified in Section 2(b)(1)-(2) are not Copyright and Similar 91 | Rights. 92 | 93 | d. Effective Technological Measures means those measures that, in the 94 | absence of proper authority, may not be circumvented under laws 95 | fulfilling obligations under Article 11 of the WIPO Copyright 96 | Treaty adopted on December 20, 1996, and/or similar international 97 | agreements. 98 | 99 | e. Exceptions and Limitations means fair use, fair dealing, and/or 100 | any other exception or limitation to Copyright and Similar Rights 101 | that applies to Your use of the Licensed Material. 102 | 103 | f. Licensed Material means the artistic or literary work, database, 104 | or other material to which the Licensor applied this Public 105 | License. 106 | 107 | g. Licensed Rights means the rights granted to You subject to the 108 | terms and conditions of this Public License, which are limited to 109 | all Copyright and Similar Rights that apply to Your use of the 110 | Licensed Material and that the Licensor has authority to license. 111 | 112 | h. Licensor means the individual(s) or entity(ies) granting rights 113 | under this Public License. 114 | 115 | i. Share means to provide material to the public by any means or 116 | process that requires permission under the Licensed Rights, such 117 | as reproduction, public display, public performance, distribution, 118 | dissemination, communication, or importation, and to make material 119 | available to the public including in ways that members of the 120 | public may access the material from a place and at a time 121 | individually chosen by them. 122 | 123 | j. Sui Generis Database Rights means rights other than copyright 124 | resulting from Directive 96/9/EC of the European Parliament and of 125 | the Council of 11 March 1996 on the legal protection of databases, 126 | as amended and/or succeeded, as well as other essentially 127 | equivalent rights anywhere in the world. 128 | 129 | k. You means the individual or entity exercising the Licensed Rights 130 | under this Public License. Your has a corresponding meaning. 131 | 132 | 133 | Section 2 -- Scope. 134 | 135 | a. License grant. 136 | 137 | 1. Subject to the terms and conditions of this Public License, 138 | the Licensor hereby grants You a worldwide, royalty-free, 139 | non-sublicensable, non-exclusive, irrevocable license to 140 | exercise the Licensed Rights in the Licensed Material to: 141 | 142 | a. reproduce and Share the Licensed Material, in whole or 143 | in part; and 144 | 145 | b. produce, reproduce, and Share Adapted Material. 146 | 147 | 2. Exceptions and Limitations. For the avoidance of doubt, where 148 | Exceptions and Limitations apply to Your use, this Public 149 | License does not apply, and You do not need to comply with 150 | its terms and conditions. 151 | 152 | 3. Term. The term of this Public License is specified in Section 153 | 6(a). 154 | 155 | 4. Media and formats; technical modifications allowed. The 156 | Licensor authorizes You to exercise the Licensed Rights in 157 | all media and formats whether now known or hereafter created, 158 | and to make technical modifications necessary to do so. The 159 | Licensor waives and/or agrees not to assert any right or 160 | authority to forbid You from making technical modifications 161 | necessary to exercise the Licensed Rights, including 162 | technical modifications necessary to circumvent Effective 163 | Technological Measures. For purposes of this Public License, 164 | simply making modifications authorized by this Section 2(a) 165 | (4) never produces Adapted Material. 166 | 167 | 5. Downstream recipients. 168 | 169 | a. Offer from the Licensor -- Licensed Material. Every 170 | recipient of the Licensed Material automatically 171 | receives an offer from the Licensor to exercise the 172 | Licensed Rights under the terms and conditions of this 173 | Public License. 174 | 175 | b. No downstream restrictions. You may not offer or impose 176 | any additional or different terms or conditions on, or 177 | apply any Effective Technological Measures to, the 178 | Licensed Material if doing so restricts exercise of the 179 | Licensed Rights by any recipient of the Licensed 180 | Material. 181 | 182 | 6. No endorsement. Nothing in this Public License constitutes or 183 | may be construed as permission to assert or imply that You 184 | are, or that Your use of the Licensed Material is, connected 185 | with, or sponsored, endorsed, or granted official status by, 186 | the Licensor or others designated to receive attribution as 187 | provided in Section 3(a)(1)(A)(i). 188 | 189 | b. Other rights. 190 | 191 | 1. Moral rights, such as the right of integrity, are not 192 | licensed under this Public License, nor are publicity, 193 | privacy, and/or other similar personality rights; however, to 194 | the extent possible, the Licensor waives and/or agrees not to 195 | assert any such rights held by the Licensor to the limited 196 | extent necessary to allow You to exercise the Licensed 197 | Rights, but not otherwise. 198 | 199 | 2. Patent and trademark rights are not licensed under this 200 | Public License. 201 | 202 | 3. To the extent possible, the Licensor waives any right to 203 | collect royalties from You for the exercise of the Licensed 204 | Rights, whether directly or through a collecting society 205 | under any voluntary or waivable statutory or compulsory 206 | licensing scheme. In all other cases the Licensor expressly 207 | reserves any right to collect such royalties. 208 | 209 | 210 | Section 3 -- License Conditions. 211 | 212 | Your exercise of the Licensed Rights is expressly made subject to the 213 | following conditions. 214 | 215 | a. Attribution. 216 | 217 | 1. If You Share the Licensed Material (including in modified 218 | form), You must: 219 | 220 | a. retain the following if it is supplied by the Licensor 221 | with the Licensed Material: 222 | 223 | i. identification of the creator(s) of the Licensed 224 | Material and any others designated to receive 225 | attribution, in any reasonable manner requested by 226 | the Licensor (including by pseudonym if 227 | designated); 228 | 229 | ii. a copyright notice; 230 | 231 | iii. a notice that refers to this Public License; 232 | 233 | iv. a notice that refers to the disclaimer of 234 | warranties; 235 | 236 | v. a URI or hyperlink to the Licensed Material to the 237 | extent reasonably practicable; 238 | 239 | b. indicate if You modified the Licensed Material and 240 | retain an indication of any previous modifications; and 241 | 242 | c. indicate the Licensed Material is licensed under this 243 | Public License, and include the text of, or the URI or 244 | hyperlink to, this Public License. 245 | 246 | 2. You may satisfy the conditions in Section 3(a)(1) in any 247 | reasonable manner based on the medium, means, and context in 248 | which You Share the Licensed Material. For example, it may be 249 | reasonable to satisfy the conditions by providing a URI or 250 | hyperlink to a resource that includes the required 251 | information. 252 | 253 | 3. If requested by the Licensor, You must remove any of the 254 | information required by Section 3(a)(1)(A) to the extent 255 | reasonably practicable. 256 | 257 | 4. If You Share Adapted Material You produce, the Adapter's 258 | License You apply must not prevent recipients of the Adapted 259 | Material from complying with this Public License. 260 | 261 | 262 | Section 4 -- Sui Generis Database Rights. 263 | 264 | Where the Licensed Rights include Sui Generis Database Rights that 265 | apply to Your use of the Licensed Material: 266 | 267 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right 268 | to extract, reuse, reproduce, and Share all or a substantial 269 | portion of the contents of the database; 270 | 271 | b. if You include all or a substantial portion of the database 272 | contents in a database in which You have Sui Generis Database 273 | Rights, then the database in which You have Sui Generis Database 274 | Rights (but not its individual contents) is Adapted Material; and 275 | 276 | c. You must comply with the conditions in Section 3(a) if You Share 277 | all or a substantial portion of the contents of the database. 278 | 279 | For the avoidance of doubt, this Section 4 supplements and does not 280 | replace Your obligations under this Public License where the Licensed 281 | Rights include other Copyright and Similar Rights. 282 | 283 | 284 | Section 5 -- Disclaimer of Warranties and Limitation of Liability. 285 | 286 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE 287 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS 288 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF 289 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, 290 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, 291 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR 292 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, 293 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT 294 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT 295 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. 296 | 297 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE 298 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, 299 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, 300 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, 301 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR 302 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN 303 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR 304 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR 305 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. 306 | 307 | c. The disclaimer of warranties and limitation of liability provided 308 | above shall be interpreted in a manner that, to the extent 309 | possible, most closely approximates an absolute disclaimer and 310 | waiver of all liability. 311 | 312 | 313 | Section 6 -- Term and Termination. 314 | 315 | a. This Public License applies for the term of the Copyright and 316 | Similar Rights licensed here. However, if You fail to comply with 317 | this Public License, then Your rights under this Public License 318 | terminate automatically. 319 | 320 | b. Where Your right to use the Licensed Material has terminated under 321 | Section 6(a), it reinstates: 322 | 323 | 1. automatically as of the date the violation is cured, provided 324 | it is cured within 30 days of Your discovery of the 325 | violation; or 326 | 327 | 2. upon express reinstatement by the Licensor. 328 | 329 | For the avoidance of doubt, this Section 6(b) does not affect any 330 | right the Licensor may have to seek remedies for Your violations 331 | of this Public License. 332 | 333 | c. For the avoidance of doubt, the Licensor may also offer the 334 | Licensed Material under separate terms or conditions or stop 335 | distributing the Licensed Material at any time; however, doing so 336 | will not terminate this Public License. 337 | 338 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public 339 | License. 340 | 341 | 342 | Section 7 -- Other Terms and Conditions. 343 | 344 | a. The Licensor shall not be bound by any additional or different 345 | terms or conditions communicated by You unless expressly agreed. 346 | 347 | b. Any arrangements, understandings, or agreements regarding the 348 | Licensed Material not stated herein are separate from and 349 | independent of the terms and conditions of this Public License. 350 | 351 | 352 | Section 8 -- Interpretation. 353 | 354 | a. For the avoidance of doubt, this Public License does not, and 355 | shall not be interpreted to, reduce, limit, restrict, or impose 356 | conditions on any use of the Licensed Material that could lawfully 357 | be made without permission under this Public License. 358 | 359 | b. To the extent possible, if any provision of this Public License is 360 | deemed unenforceable, it shall be automatically reformed to the 361 | minimum extent necessary to make it enforceable. If the provision 362 | cannot be reformed, it shall be severed from this Public License 363 | without affecting the enforceability of the remaining terms and 364 | conditions. 365 | 366 | c. No term or condition of this Public License will be waived and no 367 | failure to comply consented to unless expressly agreed to by the 368 | Licensor. 369 | 370 | d. Nothing in this Public License constitutes or may be interpreted 371 | as a limitation upon, or waiver of, any privileges and immunities 372 | that apply to the Licensor or You, including from the legal 373 | processes of any jurisdiction or authority. 374 | 375 | 376 | ======================================================================= 377 | 378 | Creative Commons is not a party to its public 379 | licenses. Notwithstanding, Creative Commons may elect to apply one of 380 | its public licenses to material it publishes and in those instances 381 | will be considered the “Licensor.” The text of the Creative Commons 382 | public licenses is dedicated to the public domain under the CC0 Public 383 | Domain Dedication. Except for the limited purpose of indicating that 384 | material is shared under a Creative Commons public license or as 385 | otherwise permitted by the Creative Commons policies published at 386 | creativecommons.org/policies, Creative Commons does not authorize the 387 | use of the trademark "Creative Commons" or any other trademark or logo 388 | of Creative Commons without its prior written consent including, 389 | without limitation, in connection with any unauthorized modifications 390 | to any of its public licenses or any other arrangements, 391 | understandings, or agreements concerning use of licensed material. For 392 | the avoidance of doubt, this paragraph does not form part of the 393 | public licenses. 394 | 395 | Creative Commons may be contacted at creativecommons.org. 396 | -------------------------------------------------------------------------------- /fonts/Petrona-Light.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/Petrona-Light.ttf -------------------------------------------------------------------------------- /fonts/Petrona-LightItalic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/Petrona-LightItalic.ttf -------------------------------------------------------------------------------- /fonts/Petrona-Medium.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/Petrona-Medium.ttf -------------------------------------------------------------------------------- /fonts/Petrona-MediumItalic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/Petrona-MediumItalic.ttf -------------------------------------------------------------------------------- /fonts/Petrona-Thin.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/Petrona-Thin.ttf -------------------------------------------------------------------------------- /fonts/Petrona-ThinItalic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/Petrona-ThinItalic.ttf -------------------------------------------------------------------------------- /fonts/cmunbmr.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/cmunbmr.ttf -------------------------------------------------------------------------------- /fonts/cmunbtl.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/cmunbtl.ttf -------------------------------------------------------------------------------- /fonts/cmunbto.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/cmunbto.ttf -------------------------------------------------------------------------------- /fonts/droid-sans-fallback.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/droid-sans-fallback.ttf -------------------------------------------------------------------------------- /fonts/mplus-1mn-bold.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/mplus-1mn-bold.ttf -------------------------------------------------------------------------------- /fonts/mplus-1mn-light.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/mplus-1mn-light.ttf -------------------------------------------------------------------------------- /fonts/mplus-1mn-medium.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/mplus-1mn-medium.ttf -------------------------------------------------------------------------------- /fonts/mplus-1mn-regular.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/mplus-1mn-regular.ttf -------------------------------------------------------------------------------- /fonts/mplus-1mn-thin.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/mplus-1mn-thin.ttf -------------------------------------------------------------------------------- /fonts/mplus-1p-regular-fallback.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/fonts/mplus-1p-regular-fallback.ttf -------------------------------------------------------------------------------- /global-config.adoc: -------------------------------------------------------------------------------- 1 | :company: RISC-V 2 | :url-riscv: https://riscv.org 3 | :doctype: book 4 | -------------------------------------------------------------------------------- /images/draft.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/images/draft.png -------------------------------------------------------------------------------- /images/risc-v_logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riscv/docs-resources/75584724da23f0c1ae8b5dbfc788e410493b89c4/images/risc-v_logo.png -------------------------------------------------------------------------------- /images/risc-v_logo.svg: -------------------------------------------------------------------------------- 1 | 2 | image/svg+xml 83 | -------------------------------------------------------------------------------- /themes/riscv-pdf.yml: -------------------------------------------------------------------------------- 1 | --- 2 | extends: default 3 | font: 4 | catalog: 5 | merge: true 6 | sans-serif: GEM_FONTS_DIR/mplus1p-regular-fallback.ttf 7 | #Petrona 8 | body: 9 | normal: Petrona-Light.ttf 10 | bold: Petrona-Medium.ttf 11 | italic: Petrona-LightItalic.ttf 12 | bold_italic: Petrona-MediumItalic.ttf 13 | header_thin: Petrona-Thin.ttf 14 | #Montserrat 15 | headings: 16 | normal: Montserrat-Regular.ttf 17 | italic: Montserrat-Italic.ttf 18 | bold: Montserrat-Medium.ttf 19 | light: Montserrat-Light.ttf 20 | code: 21 | normal: cmunbtl.ttf 22 | bold: cmunbtl.ttf 23 | italic: cmunbto.ttf 24 | bold_italic: cmunbto.ttf 25 | # M+ 1mn supports ASCII and the circled numbers used for conums 26 | M+ 1mn: 27 | normal: mplus-1mn-regular.ttf 28 | bold: mplus-1mn-bold.ttf 29 | italic: mplus-1mn-light.ttf 30 | bold_italic: mplus-1mn-medium.ttf 31 | M+ 1p Fallback: 32 | normal: mplus-1p-regular-fallback.ttf 33 | bold: mplus-1p-regular-fallback.ttf 34 | italic: mplus-1p-regular-fallback.ttf 35 | bold_italic: mplus-1p-regular-fallback.ttf 36 | Droid Fallback: 37 | normal: droid-sans-fallback.ttf 38 | italic: droid-sans-fallback.ttf 39 | bold: droid-sans-fallback.ttf 40 | bold_italic: droid-sans-fallback.ttf 41 | JetBrainsMono: 42 | normal: JetBrainsMono-Regular.ttf 43 | italic: JetBrainsMono-Italic.ttf 44 | bold: JetBrainsMono-Bold.ttf 45 | bold_italic: JetBrainsMono-BoldItalic.ttf 46 | # M+ 1p supports Latin, Latin-1 Supplement, Latin Extended, Greek, Cyrillic, Vietnamese, Japanese & an assortment of symbols 47 | # It also provides arrows for ->, <-, => and <= replacements in case these glyphs are missing from font 48 | fallbacks: 49 | - M+ 1p Fallback 50 | - Droid Fallback 51 | svg: 52 | fallback-font-family: M+ 1mn 53 | page: 54 | background_color: ffffff 55 | layout: portrait 56 | margin: [0.5in, 0.67in, 0.67in, 0.67in] 57 | # margin_inner and margin_outer keys are used for recto/verso print margins when media=prepress 58 | margin_inner: 0.75in 59 | margin_outer: 0.59in 60 | size: A4 61 | base: 62 | font-family: body 63 | font_size: 11 64 | line_height_length: 12 65 | font_style: normal 66 | font_size_large: round($base_font_size * 1.25) 67 | font_size_small: round($base_font_size * 0.85) 68 | font_size_min: round($base_font_size * 0.86) 69 | border_radius: 3 70 | border_width: 0.25 71 | border_color: EEEEEE 72 | vertical_rhythm: $base_line_height_length 73 | horizontal_rhythm: $base_line_height_length 74 | # QUESTION should vertical_spacing be block_spacing instead? 75 | vertical_spacing: $vertical_rhythm 76 | link: 77 | font_color: 428bca 78 | # codespan is currently used for inline monospaced in prose and table cells 79 | codespan: 80 | font-color: 000000 81 | font_family: JetBrainsMono 82 | font_style: normal 83 | font-size: $base_font_size_min 84 | menu_caret_content: ' › ' 85 | heading: 86 | align: left 87 | margin_bottom: $block_margin_bottom 88 | #margin_top: 0.25in 89 | margin_top: $block_margin_bottom 90 | min_height_after: auto 91 | font_color: 000000 92 | font_family: headings 93 | font_style: bold 94 | h1_font_size: 2em 95 | h2-font-size: 1.5em 96 | h3-font-size: 1.17em 97 | h4-font-size: 1em 98 | h5-font-size: .83em 99 | h6_font_size: .67em 100 | title_page: 101 | align: center 102 | logo: 103 | top: 10% 104 | title: 105 | font_family: headings 106 | font_style: light 107 | font_size: floor($base_font_size * 2.8) 108 | top: 55% 109 | font_color: 3e058e 110 | subtitle: 111 | font_family: headings 112 | font_style: light 113 | font_size: floor($base_font_size * 1.2) 114 | margin-top: 25 115 | authors: 116 | font_family: headings 117 | font_color: 3e058e 118 | font_style: light 119 | font_size: floor($base_font_size * .8) 120 | revision: 121 | margin_top: $base_font_size * 1.25 122 | block: 123 | margin_top: 0 124 | margin_bottom: $vertical_rhythm 125 | caption: 126 | align: left 127 | font_size: $base_font_size * 0.95 128 | font_style: italic 129 | # FIXME perhaps set line_height instead of / in addition to margins? 130 | margin_inside: $vertical_rhythm / 3 131 | #margin_inside: $vertical_rhythm / 4 132 | margin_outside: 0 133 | lead: 134 | font_size: $base_font_size_large 135 | line_height: 1.4 136 | abstract: 137 | font_color: 5c6266 138 | font_size: $lead_font_size 139 | line_height: $lead_line_height 140 | font_style: italic 141 | first_line_font_style: bold 142 | title: 143 | align: left 144 | font_color: $heading_font_color 145 | font_family: $heading_font_family 146 | font_size: $heading_h4_font_size 147 | font_style: $heading_font_style 148 | sidebar: 149 | font-style: italic 150 | background-color: f5f5fc 151 | border-color: 8d81b8 152 | border-radius: 3 153 | border-width: 0.2 154 | sidebar-title: 155 | font_family: $heading_font_family 156 | font-style: light 157 | font-color: $heading-font-color 158 | font-size: 11 159 | align: left 160 | admonition: 161 | font-style: italic 162 | column_rule_color: $base_border_color 163 | column_rule_width: $base_border_width 164 | padding: [0, $horizontal_rhythm, 0, $horizontal_rhythm] 165 | icon: 166 | note: 167 | # name: pencil-square-o 168 | # name: far-edit 169 | name: fas-info-circle 170 | stroke_color: 6489b3 171 | tip: 172 | #name: comments-o 173 | name: far-comments 174 | stroke_color: 646b74 175 | size: 24 176 | important: 177 | #name: info 178 | name: fas-info-circle 179 | stroke_color: 5f8c8b 180 | warning: 181 | stroke_color: 9c4d4b 182 | caution: 183 | stroke_color: c99a2c 184 | label: 185 | text_transform: uppercase 186 | font_style: bold 187 | #blockquote: 188 | # font_color: $base_font_color 189 | # font_size: $base_font_size_large 190 | # border_color: $base_border_color 191 | # border_width: 2 192 | # FIXME disable negative padding bottom once margin collapsing is implemented 193 | # padding: [0, $horizontal_rhythm, $block_margin_bottom * -0.75, $horizontal_rhythm + $blockquote_border_width / 2] 194 | # cite_font_size: $base_font_size_small 195 | # cite_font_color: 51278d 196 | # code is used for source blocks (perhaps change to source or listing?) 197 | code: 198 | #font_color: $base_font_color 199 | font-color: 000000 200 | font_family: $codespan_font_family 201 | #font_size: ceil($base_font_size) 202 | font-size: 10 203 | padding: $code_font_size 204 | line_height: 1.15 205 | # line_gap is an experimental property to control how a background color is applied to an inline block element 206 | line_gap: 3.8 207 | #background_color: f4f4fb 208 | background_color: ffffff 209 | #border_color: cccccc 210 | #border_radius: $base_border_radius 211 | #border_width: 0.2 212 | caption: 213 | end: bottom 214 | conum: 215 | font_family: M+ 1mn 216 | font_color: $codespan_font_color 217 | font_size: $base_font_size 218 | line_height: 4 / 3 219 | example: 220 | border_color: $base_border_color 221 | border_radius: $base_border_radius 222 | border_width: 0.2 223 | background_color: ffffff 224 | # FIXME re-enable padding bottom once margin collapsing is implemented 225 | padding: [$vertical_rhythm, $horizontal_rhythm, 0, $horizontal_rhythm] 226 | image: 227 | align: left 228 | caption: 229 | align: center 230 | prose: 231 | margin_top: $block_margin_top 232 | margin_bottom: $block_margin_bottom 233 | thematic_break: 234 | border_color: $base_border_color 235 | border_style: solid 236 | border_width: $base_border_width 237 | margin_top: $vertical_rhythm * 0.5 238 | margin_bottom: $vertical_rhythm * 1.5 239 | description_list: 240 | term_font_style: bold 241 | term_spacing: $vertical_rhythm / 4 242 | description_indent: $horizontal_rhythm * 1.25 243 | #list: 244 | # indent: $horizontal_rhythm * 1.5 245 | #marker_font_color: 404040 246 | # NOTE outline_list_item_spacing applies to list items that do not have complex content 247 | # item_spacing: $vertical_rhythm / 2 248 | # List settings 249 | list: 250 | indent: $horizontal_rhythm * 1.5 251 | item_spacing: $vertical_rhythm / 2 252 | bullet: 253 | font_size: round($base_font_size * 1.5) 254 | content: • 255 | marker: 256 | font-family: JetBrainsMono 257 | ulist: 258 | marker: 259 | disc: 260 | content: ⚫ 261 | circle: 262 | content: ⚫ 263 | square: 264 | content: ■ 265 | font-family: JetBrainsMono 266 | # List of figures settings 267 | lof: 268 | label_width: 3em # Adjust the width for figure labels 269 | align: left 270 | caption: 271 | indent: 4em # Ensure captions align consistently 272 | font-family: JetBrainsMono 273 | # List of tables settings 274 | lot: 275 | label_width: 3em # Adjust the width for table labels 276 | align: left 277 | caption: 278 | indent: 4em # Ensure captions align consistently 279 | font-family: JetBrainsMono 280 | #ulist: 281 | # marker: 282 | # font-size: 10 283 | # font-style: bold 284 | figure: 285 | caption: 286 | end: bottom 287 | align: center 288 | table: 289 | background_color: $page_background_color 290 | font-size: $base_font_size * 0.9em 291 | #head_background_color: #2596be 292 | #head_font_color: $base_font_color 293 | head_font_style: bold 294 | #body_background_color: 295 | body_stripe_background_color: d7d7d7 296 | foot_background_color: f0f0f0 297 | border_color: dddddd 298 | border_width: $base_border_width 299 | cell_padding: 3 300 | caption: 301 | end: top 302 | align: center 303 | text-align: center 304 | max-width: none 305 | toc: 306 | indent: $horizontal_rhythm 307 | line_height: 1.4 308 | dot-leader: 309 | content: . 310 | font_color: a9a9a9 311 | font-style: bold 312 | #levels: 2 313 | h2-font-style: bold 314 | # NOTE in addition to footer, header is also supported 315 | header: 316 | font_size: $base_font_size_small 317 | border_color: dddddd 318 | border_width: 0.35 319 | height: $base_line_height_length * 2.6 320 | line_height: 1 321 | padding: [$base_line_height_length / 1, 1, .5, 1] 322 | vertical_align: margin_inside 323 | recto: 324 | right: 325 | content: '{section-or-chapter-title} | Page {page-number}' 326 | verso: 327 | left: 328 | content: '{section-or-chapter-title} | Page {page-number}' 329 | footer: 330 | font_size: $base_font_size_small 331 | border_color: dddddd 332 | border_width: 0.35 333 | height: $base_line_height_length * 2.6 334 | line_height: 1 335 | padding: [$base_line_height_length / 1, 1, .5, 1] 336 | vertical_align: top 337 | #image_vertical_align: or 338 | # additional attributes for content: 339 | # content: '{company}' 340 | # * {page-count} 341 | # * {page-number} 342 | #center: 343 | #content: '{document-title}' 344 | # * {document-subtitle} 345 | # * {chapter-title} 346 | # * {section-title} 347 | # * {section-or-chapter-title} 348 | recto: 349 | #columns: "<50% =0% >50%" 350 | right: 351 | #content: '{page-number}' 352 | content: '{document-title} | © RISC-V International' 353 | #content: '{document-title} | © RISC-V' 354 | #center: '{page-number}' 355 | #content: '{revdate}' 356 | verso: 357 | #columns: $footer_recto_columns 358 | left: 359 | content: $footer_recto_right_content 360 | #center: '{page-number}' 361 | #content: '{page-number}' 362 | --------------------------------------------------------------------------------