Skip to content

Commit

Permalink
Fix typos (#241)
Browse files Browse the repository at this point in the history
  • Loading branch information
deining authored Feb 11, 2024
1 parent 8463632 commit a2261e9
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
12 changes: 6 additions & 6 deletions docs/COMPILE.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ _Scene_

Prepends each scene's title (its note name) before its content. Options:

| Name | Type | Default | Description |
| ------------ | ---- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Title Format | Text | $1 | A format string that lets you customize how the title is inserted. A `$1` in the string will be replaced with the scene title. A `$2`, if present, will be replaced with the scene’s number (first scene is “1,“ it’s child is “1.1,” etc.). Wrapping text in $3{} will repeat that text a number of times equal to the scene’s indentation level plus one—e.g., $3{#} for unindented scenes becomes “#”. |
| Separator | Text | \n\n | Some text to insert between the formatted title and the rest of the scene. |
| Name | Type | Default | Description |
| ------------ | ---- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Title Format | Text | $1 | A format string that lets you customize how the title is inserted. A `$1` in the string will be replaced with the scene title. A `$2`, if present, will be replaced with the scene’s number (first scene is “1,“ it’s child is “1.1,” etc.). Wrapping text in $3{} will repeat that text a number of times equal to the scene’s indentation level plus one—e.g., $3{#} for unindented scenes becomes “#”. |
| Separator | Text | \n\n | Some text to insert between the formatted title and the rest of the scene. |

#### Remove Comments

Expand Down Expand Up @@ -183,7 +183,7 @@ Once loaded, the user script will be available in the Add Step menu of Compile.

## Workflows

In Compile, steps are organized into workflows. Longform ships with a defaut workflow that demonstrates Compile and produces a simple formatted manuscript. Feel free to customize or delete the default workflow.
In Compile, steps are organized into workflows. Longform ships with a default workflow that demonstrates Compile and produces a simple formatted manuscript. Feel free to customize or delete the default workflow.

You can create new workflows to suit each of your projects. Each workflow has a description box you may use to remind yourself what exactly the workflow does. A Longform project remembers its last-used workflow and will select it first when you next open the Compile tab.

Expand All @@ -193,4 +193,4 @@ You can drag steps within a workflow to rearrange them.

## The Future

Compile remains a feature that will change over time. [Open issues](https://github.com/kevboh/longform/issues?q=is%3Aissue+is%3Aopen+label%3Acompile) are a good way to track what's on the roadmap. I plan on adding more steps and a few more features that allow you to fully customize what happens inside a given workflow. As always, if you think a step should be added or changed, or that compile should behave differently, pleaes open an issue in GitHub.
Compile remains a feature that will change over time. [Open issues](https://github.com/kevboh/longform/issues?q=is%3Aissue+is%3Aopen+label%3Acompile) are a good way to track what's on the roadmap. I plan on adding more steps and a few more features that allow you to fully customize what happens inside a given workflow. As always, if you think a step should be added or changed, or that compile should behave differently, please open an issue in GitHub.
2 changes: 1 addition & 1 deletion src/api/LongformAPI.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export class LongformAPI {
/**
* Converts a YAML-compatible potentially-nested array of strings into a single-dimension array of `{title: string; indent: number}` objects.
*
* Longform uses the YAML format to store scenes with indentation information; this function is useful if you want to read that YAML yourself and convert it into data you can reason about. For examle, the YAML:
* Longform uses the YAML format to store scenes with indentation information; this function is useful if you want to read that YAML yourself and convert it into data you can reason about. For example, the YAML:
*
* ```yaml
* - My First Scene
Expand Down
2 changes: 1 addition & 1 deletion src/compile/steps/remove-links.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ export function replaceWikiLinks(contents: string): string {
if (startOfAlias >= 0) {
additionalAlias = true;
}
startOfAlias = i + 1; // update to ealiest instance of the character
startOfAlias = i + 1; // update to earliest instance of the character
continue;
}
if (char === "[") {
Expand Down
4 changes: 2 additions & 2 deletions src/compile/steps/write-to-note.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ async function ensureContainingFolderExists(
app: App,
filePath: string
): Promise<void> {
const conatiningFolderParts = filePath.split("/");
const containingFolderPath = conatiningFolderParts.slice(0, -1).join("/");
const containingFolderParts = filePath.split("/");
const containingFolderPath = containingFolderParts.slice(0, -1).join("/");

try {
await app.vault.createFolder(containingFolderPath);
Expand Down
2 changes: 1 addition & 1 deletion src/view/compile/add-step-modal/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export default class AddStepModalContainer extends Modal {
onOpen(): void {
const { contentEl } = this;

contentEl.createEl("h1", { text: "Add Compile Step to Workfow" });
contentEl.createEl("h1", { text: "Add Compile Step to Workflow" });
const entrypoint = contentEl.createDiv("longform-add-step-root");

const context = appContext(this);
Expand Down

0 comments on commit a2261e9

Please sign in to comment.