diff --git a/docs/book.toml b/docs/book.toml index 8e74746f..5afd6cd8 100644 --- a/docs/book.toml +++ b/docs/book.toml @@ -8,6 +8,6 @@ title = "Yarn Slinger Book" [output.html] git-repository-url = "https://github.com/yarn-slinger/yarn-slinger" git-repository-icon = "fa-github" -edit-url-template = "https://github.com/yarn-slinger/yarn-slinger/edit/main/docs/src/{path}" +edit-url-template = "https://github.com/yarn-slinger/yarn-slinger/edit/main/docs/{path}" site-url = "/yarn-slinger/" cname = "https://yarn-slinger.github.io" diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 4901aaae..a6ac8460 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,22 +1,23 @@ - [Introduction](./introduction.md) -- [Yarn Files](./yarn_files.md) - - [Basics](./yarn_files/basics.md) - - [Running Examples](./yarn_files/running_examples.md) - - [Lines](./yarn_files/lines.md) - - [Variables](./yarn_files/variables.md) - - [Options](./yarn_files/options.md) - - [Nodes](./yarn_files/nodes.md) - - [Markup](./yarn_files/markup.md) - - [Functions](./yarn_files/functions.md) - - [Commands](./yarn_files/commands.md) -- [Bevy Plugin](./bevy_plugin.md) - - [Setup](./bevy_plugin/setup.md) - - [Compiling Yarn Files](./bevy_plugin/compiling_yarn_files.md) - - [`DialogRunner` and a High Level Overview](./bevy_plugin/dialog_runner.md) - - [Localization](./bevy_plugin/localization.md) - - [Assets](./bevy_plugin/assets.md) - - [Variable Storage](./bevy_plugin/variable_storage.md) - - [Custom Functions](./bevy_plugin/custom_functions.md) - - [Custom Commands](./bevy_plugin/custom_commands.md) - - [Dialog Views](./bevy_plugin/dialog_views.md) +- [Working with Yarn Slinger](./working_with_yarn_slinger.md) + - [Yarn Files](./yarn_files.md) + - [Basics](./yarn_files/basics.md) + - [Running Examples](./yarn_files/running_examples.md) + - [Lines](./yarn_files/lines.md) + - [Variables](./yarn_files/variables.md) + - [Options](./yarn_files/options.md) + - [Nodes](./yarn_files/nodes.md) + - [Markup](./yarn_files/markup.md) + - [Functions](./yarn_files/functions.md) + - [Commands](./yarn_files/commands.md) + - [Bevy Plugin](./bevy_plugin.md) + - [Setup](./bevy_plugin/setup.md) + - [Compiling Yarn Files](./bevy_plugin/compiling_yarn_files.md) + - [`DialogRunner` and a High Level Overview](./bevy_plugin/dialog_runner.md) + - [Localization](./bevy_plugin/localization.md) + - [Assets](./bevy_plugin/assets.md) + - [Variable Storage](./bevy_plugin/variable_storage.md) + - [Custom Functions](./bevy_plugin/custom_functions.md) + - [Custom Commands](./bevy_plugin/custom_commands.md) + - [Dialog Views](./bevy_plugin/dialog_views.md) - [Porting Yarn Slinger](./porting_yarn_slinger.md) diff --git a/docs/src/bevy_plugin/assets.md b/docs/src/bevy_plugin/assets.md index f66bb4fb..ca1f3235 100644 --- a/docs/src/bevy_plugin/assets.md +++ b/docs/src/bevy_plugin/assets.md @@ -22,5 +22,5 @@ These annotations will also be written into the "comment" field of strings files ## Asset Providers -TODO +TODO (Feel free to [contribute](https://github.com/yarn-slinger/yarn-slinger/edit/main/docs/src/bevy_plugin/assets.md)!) diff --git a/docs/src/bevy_plugin/custom_commands.md b/docs/src/bevy_plugin/custom_commands.md index 628430e5..ad086d23 100644 --- a/docs/src/bevy_plugin/custom_commands.md +++ b/docs/src/bevy_plugin/custom_commands.md @@ -1,3 +1,3 @@ # Custom Commands -TODO +TODO (Feel free to [contribute](https://github.com/yarn-slinger/yarn-slinger/edit/main/docs/src/bevy_plugin/custom_commands.md)!) diff --git a/docs/src/bevy_plugin/custom_functions.md b/docs/src/bevy_plugin/custom_functions.md index 9d607e2e..438e239f 100644 --- a/docs/src/bevy_plugin/custom_functions.md +++ b/docs/src/bevy_plugin/custom_functions.md @@ -1,3 +1,3 @@ # Custom Functions -TODO +TODO (Feel free to [contribute](https://github.com/yarn-slinger/yarn-slinger/edit/main/docs/src/bevy_plugin/custom_functions.md)!) \ No newline at end of file diff --git a/docs/src/bevy_plugin/dialog_views.md b/docs/src/bevy_plugin/dialog_views.md index 262383ec..52098c54 100644 --- a/docs/src/bevy_plugin/dialog_views.md +++ b/docs/src/bevy_plugin/dialog_views.md @@ -1,3 +1,3 @@ # Dialog Views -TODO +TODO (Feel free to [contribute](https://github.com/yarn-slinger/yarn-slinger/edit/main/docs/src/bevy_plugin/dialog_views.md)!) diff --git a/docs/src/bevy_plugin/variable_storage.md b/docs/src/bevy_plugin/variable_storage.md index d9e545c4..109563bf 100644 --- a/docs/src/bevy_plugin/variable_storage.md +++ b/docs/src/bevy_plugin/variable_storage.md @@ -1,3 +1,3 @@ # Variable Storage -TODO +TODO (Feel free to [contribute](https://github.com/yarn-slinger/yarn-slinger/edit/main/docs/src/bevy_plugin/variable_storage.md)!) diff --git a/docs/src/working_with_yarn_slinger.md b/docs/src/working_with_yarn_slinger.md new file mode 100644 index 00000000..7a6d5273 --- /dev/null +++ b/docs/src/working_with_yarn_slinger.md @@ -0,0 +1,5 @@ +# Working with Yarn Slinger + +Yarn Slinger is a port of the widely used dialogue tool [Yarn Spinner](https://yarnspinner.dev/). +They both share the idea of writing dialog in writer-friendly text files called Yarn files. +We will take a look at how to write these in the next chapter, [Yarn Files](./yarn_files.md). diff --git a/docs/src/yarn_files/markup.md b/docs/src/yarn_files/markup.md index 435c201a..f5cd90d3 100644 --- a/docs/src/yarn_files/markup.md +++ b/docs/src/yarn_files/markup.md @@ -1,3 +1,3 @@ # Markup -TODO +TODO (Feel free to [contribute](https://github.com/yarn-slinger/yarn-slinger/edit/main/docs/src/yarn_files/markup.md)!) \ No newline at end of file