Documentation

[Taitava]

I can't remember if I've yet written about this, but the documentation is lagging behind, there are quite many features that the README.md file does not mention at all. This is partly intentional, partly laziness. I do not want to grow README.md much longer than it currently is. I'm planning to write separate documentation in a separate repository. It will be an Obsidian vault, at least at the beginning.

Topic ideas so far, but more will come later:

• Operating systems and shells
  • Operating system specific versions of shell commands
  • Choosing a shell to execute commands in
• Output handling
  • Ignoring errors
  • Output channels
• Variables
  • Escaping special characters in variable values
  • Variables - general principles
• Installation
• Upgrading
• Backing up settings

[Taitava]

The documentation has been published: https://publish.obsidian.md/shellcommands

All comments and feedback are welcome! For example, is the structure easy or hard to follow, can you find stuff that you need? There are some missing links for pages that i felt are not so important yet. But if you do find a broken link that feels important to you, please comment here.

Here's also a GitHub repository of the same vault: https://github.com/Taitava/obsidian-shellcommands-documentation (but images and links work better in the Publish site). The repository might be only useful if you plan to propose changes to the documentation by making pull requests in GitHub. The repository does not have an Issues section or Discussions section, as I like to keep all conversations here in the main repository.