Skip to content

Commit

Permalink
Merge pull request #1107 from quarto-dev/move-highlights
Browse files Browse the repository at this point in the history
Move exisiting highlights to permanent homes
  • Loading branch information
cwickham authored Jun 3, 2024
2 parents 6eaa642 + 1a57d24 commit 2b149c6
Show file tree
Hide file tree
Showing 13 changed files with 37 additions and 54 deletions.
4 changes: 2 additions & 2 deletions _freeze/docs/authoring/tables/execute-results/html.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,7 @@ website:
- docs/websites/website-basics.qmd
- docs/websites/website-navigation.qmd
- docs/websites/website-blog.qmd
- docs/websites/website-drafts.qmd
- docs/websites/website-search.qmd
- docs/websites/website-tools.qmd
- docs/websites/website-about.qmd
Expand Down
2 changes: 2 additions & 0 deletions docs/authoring/tables.qmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Tables
engine: jupyter
aliases:
- /docs/prerelease/1.5/lua-table-processing.html
---

## Overview
Expand Down
16 changes: 13 additions & 3 deletions docs/prerelease/1.5/_highlights.qmd
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
Quarto 1.5 includes the following new features:

- [Website Draft Mode](/docs/prerelease/1.5/website-drafts.qmd)---Improved support for workflows involving draft posts and pages.
- [Website Draft Mode](/docs/websites/website-drafts.qmd)---Improved support for workflows involving draft posts and pages:

- Adds the `drafts` option to the `website` key offering new ways to specify drafts: directly in `_quarto.yml`, and via metadata includes and profiles.

- Introduces the `draft-mode` option to the `website` key to control how drafts are rendered. Drafts can be `gone`, `unlinked` or `visible`.

- Adds a draft banner to draft pages that are rendered.

- Improves the linking behaviour of draft documents. Now, in addition to being excluded from search results, listings, and the sitemap, drafts will not appear in navigation, or be linked from in-text hyperlinks when `draft-mode` is `gone` or `unlinked`.

- Changes the behavior of `quarto preview` for drafts. Drafts will be `visible` in previews regardless of the `draft-mode` setting. In particular, this allows an easier way to preview the appearance of draft content in navigation and listings.

- [Native Julia Engine](/docs/computations/julia.qmd#using-the-julia-engine)---Execute Julia code in Quarto documents without requiring Jupyter.

- [Project Pre Render Scripts](/docs/prerelease/1.5/pre-render.qmd)---Project metadata and the render list are now re-computed after any pre-render scripts have executed.
- [Project Pre Render Scripts](/docs/projects/scripts.qmd#pre-and-post-render)---Project metadata and the render list are now re-computed after any pre-render scripts have executed.

- [Element-wide disabling of HTML processing](/docs/prerelease/1.5/lua-table-processing.qmd)---Additional control for table processing.
- [Element-wide disabling of HTML table processing](/docs/authoring/tables.qmd#library-authors)---Declare the comment `<!--| quarto-html-table-processing: none -->` anywhere in an HTML RawBlock.
15 changes: 0 additions & 15 deletions docs/prerelease/1.5/lua-table-processing.qmd

This file was deleted.

11 changes: 0 additions & 11 deletions docs/prerelease/1.5/pre-render.qmd

This file was deleted.

8 changes: 8 additions & 0 deletions docs/projects/scripts.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Project Scripts"
aliases:
- /docs/prerelease/1.5/pre-render.html
---

## Overview
Expand Down Expand Up @@ -59,6 +61,12 @@ The following environment variables are passed to pre and post-render scripts (n
| `QUARTO_PROJECT_INPUT_FILES` | Newline separated list of all input files being rendered (passed only to `pre-render`) |
| `QUARTO_PROJECT_OUTPUT_FILES` | Newline separated list of all output files rendered (passed only to `post-render`). |

The project metadata and render list will be re-computed after any pre-render scripts have executed, allowing them to modify this project data.
For example, a pre-render script might generate additional `qmd` files or `ipynb` files that should be rendered.

Note that pre-render scripts cannot modify the project directory, the output directory, or the project type.
If a pre-render script modifies any of these values, an error will be returned and the render will fail.

If you have a `pre-render` step that is expensive, you may want only run it when the entire project is being rendered. Here's how you would do this in the various supported script languages:

::: panel-tabset
Expand Down
4 changes: 3 additions & 1 deletion docs/websites/website-blog.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ Add a new post to your blog by creating a sub-directory within `posts`, and addi

### Drafts

Add `draft: true` to the document options if you'd like a post to not be included in the listing, site map, or site search. For example:
Add `draft: true` to the document options to indicate a post is a draft. For example:

``` yaml
---
Expand All @@ -188,6 +188,8 @@ draft: true
---
```

Draft posts will appear when you preview the site, but will be blank when you render the site and will not appear in listings, navigation, the site map, or site search. You can read more about drafts in [Website Drafts](website-drafts.qmd).

To publish the post when it is complete, simply remove `draft: true` from the document options and then render it.

### Last Updated
Expand Down
Original file line number Diff line number Diff line change
@@ -1,28 +1,14 @@
---
title: Website Draft Support
title: Website Drafts
aliases:
- /docs/prerelease/1.5/website-drafts.html
---

{{< include _pre-release-feature.qmd >}}
## Overview

## New in Quarto 1.5
Use drafts to preview and plan content before it is ready to publish. By default, draft pages will be blank in your rendered site, and will not appear in navigation, listings, search results, or the sitemap. On this page, learn how to specify pages as drafts, control how drafts appear in rendered sites and how drafts appear in site previews.

This feature improves Quarto's support for draft documents in websites. It does this a few ways:

- Adds the `drafts` option to the `website` key offering new ways to specify drafts: directly in `_quarto.yml`, and via metadata includes and profiles.

- Introduces the `draft-mode` option to the `website` key to control how drafts are rendered. Drafts can be `gone`, `unlinked` or `visible`.

- Adds a draft banner to draft pages that are rendered.

- Improves the linking behaviour of draft documents. Now, in addition to being excluded from search results, listings, and the sitemap, drafts will not appear in navigation, or be linked from in-text hyperlinks when `draft-mode` is `gone` or `unlinked`.

- Changes the behavior of `quarto preview` for drafts. Drafts will be `visible` in previews regardless of the `draft-mode` setting. In particular, this allows an easier way to preview the appearance of draft content in navigation and listings.

Read more about these changes below.

## Website Drafts

### Specifying Drafts
## Specifying Drafts

To specify a page or post is a draft, you can add `draft: true` to the document YAML:

Expand Down Expand Up @@ -68,7 +54,7 @@ metadata-files:

You can also set the website `drafts` option using [project profiles](/docs/projects/profiles.html).

### Appearance of Drafts
## Appearance of Drafts

You can use the `draft-mode` option to control the content and linking of draft documents in the rendered website.
The values for `draft-mode` are:
Expand Down Expand Up @@ -118,7 +104,7 @@ However, `stuff/item2.qmd` is still available at `stuff/item2.html` and shows th

![](images/website-drafts-item2.png){.border fig-alt="Screenshot of a webpage with title 'Item 2'. The navigation bar shows a single navigation item 'Item 1'. Above the navigation bar is a banner with the text 'Draft'."}

### Previewing Drafts
## Previewing Drafts

Regardless of the `draft-mode` setting, when you preview a site with `quarto preview` drafts will be `visible`.
Draft pages will be rendered and display a draft banner, and any links or navigation items pointing at the draft pages will be visible and active.
Expand Down

0 comments on commit 2b149c6

Please sign in to comment.