Skip to content

Commit

Permalink
orange-book:0.2.0 (#1031)
Browse files Browse the repository at this point in the history
  • Loading branch information
flavio20002 authored Oct 3, 2024
1 parent fcdaf1b commit 2c6c474
Show file tree
Hide file tree
Showing 16 changed files with 1,895 additions and 0 deletions.
14 changes: 14 additions & 0 deletions packages/preview/orange-book/0.2.0/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
MIT No Attribution

Permission is hereby granted, free of charge, to any person obtaining a copy of this
software and associated documentation files (the "Software"), to deal in the Software
without restriction, including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
70 changes: 70 additions & 0 deletions packages/preview/orange-book/0.2.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# orange-book
A book template inspired by The Legrand Orange Book of Mathias Legrand and Vel https://www.latextemplates.com/template/legrand-orange-book.

## Usage
You can use this template in the Typst web app by clicking "Start from template"
on the dashboard and searching for `orange-book`.

Alternatively, you can use the CLI to kick this project off using the command
```
typst init @preview/orange-book
```

Typst will create a new directory with all the files needed to get you started.

## Configuration
This template exports the `book` function with the following named arguments:

- `title`: The book's title as content.
- `subtitle`: The book's subtitle as content.
- `author`: Content or an array of content to specify the author.
- `paper-size`: Defaults to `a4`. Specify a [paper size
string](https://typst.app/docs/reference/layout/page/#parameters-paper) to
change the page format.
- `copyright`: Details about the copyright or
`none`.

The function also accepts a single, positional argument for the body of the
book.

The template will initialize your package with a sample call to the `book`
function in a show rule. If you, however, want to change an existing project to
use this template, you can add a show rule like this at the top of your file:

```typ
#import "@preview/orange-book:0.1.0": book
#show: book.with(
title: "Exploring the Physical Manifestation of Humanity’s Subconscious Desires",
subtitle: "A Practical Guide",
date: "Anno scolastico 2023-2024",
author: "Goro Akechi",
mainColor: rgb("#F36619"),
lang: "en",
cover: image("./background.svg"),
imageIndex: image("./orange1.jpg"),
listOfFigureTitle: "List of Figures",
listOfTableTitle: "List of Tables",
supplementChapter: "Chapter",
supplementPart: "Part",
part_style: 0,
copyright: [
Copyright © 2023 Flavio Barisi
PUBLISHED BY PUBLISHER
#link("https://github.com/flavio20002/typst-orange-template", "TEMPLATE-WEBSITE")
Licensed under the Apache 2.0 License (the “License”).
You may not use this file except in compliance with the License. You may obtain a copy of
the License at https://www.apache.org/licenses/LICENSE-2.0. Unless required by
applicable law or agreed to in writing, software distributed under the License is distributed on an
“AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.
_First printing, July 2023_
]
)
// Your content goes below.
```
Loading

0 comments on commit 2c6c474

Please sign in to comment.