Skip to content

Commit

Permalink
Add Style Guidelines (#319)
Browse files Browse the repository at this point in the history
* update README.md

* add a minimal style guide

* format backtick properly

* minor tweaks

* make "words as words" clearer
  • Loading branch information
brishtibheja authored Dec 23, 2024
1 parent 0f9cfa4 commit 7c3d3ab
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
Best viewed on the website: https://docs.ankiweb.net
# Anki Manual

This manual is licensed under the CC BY-SA 4 license:
This repository contains the source of [Anki's user manual](https://docs.ankiweb.net).

https://creativecommons.org/licenses/by-sa/4.0/
## License

Pull requests are welcome. Unless you state otherwise, any pull requests you
submit will be licensed under the above license. Please see [CONTRIBUTING](CONTRIBUTING.md) for more details.
This manual is licensed under the [CC BY-SA 4 license](https://creativecommons.org/licenses/by-sa/4.0/).

## Contributing

Contributions are welcome! Please see the [issue tracker](https://github.com/ankitects/anki-manual/issues) for things you can start working on. For details on local development, see [CONTRIBUTING](CONTRIBUTING.md).

Unless stated otherwise, any pull requests you
submit will be licensed under the [CC BY-SA 4 license](https://creativecommons.org/licenses/by-sa/).

## Style Guidelines

The following conventions are not consistently applied in the manual. If you find such text, feel free to change it.

- Use double quotes, `"`, instead of single quotes, `'`.
- For emphasis such as when defining a word, use italics, `_`.
- Also use italics when referring to a word itself rather than what it means, e.g. "To search for either _dog_ or _cat_, use `dog or cat`".
- When referring to UI elements, use bold formatting, `**`.
- When referring to keyboard buttons, wrap them with `<kbd></kbd>`.
- Use code formatting for example inputs by wrapping them with backticks, `` ` ``.

0 comments on commit 7c3d3ab

Please sign in to comment.