Skip to content

Commit

Permalink
Docmentation.md: Mention soft-wrapping when using Intellij
Browse files Browse the repository at this point in the history
  • Loading branch information
damithc committed Jul 30, 2021
1 parent 4018a43 commit d6fb70e
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ title: Documentation guide
* Note these points when adapting the documentation to a different project/product:
* The 'Site-wide settings' section of the page linked above has information on how to update site-wide elements such as the top navigation bar.
* :bulb: In addition to updating content files, you might have to update the config files `docs\_config.yml` and `docs\_sass\minima\_base.scss` (which contains a reference to `AB-3` that comes into play when converting documentation pages to PDF format).
* If you are using Intellij for editing documentation files, you can consider enabling 'soft wrapping' for `*.md` files, as explained in [_[se-edu/guides] **Intellij IDEA: Useful settings**_](https://se-education.org/guides/tutorials/intellijUsefulSettings.html#enabling-soft-wrapping)


**Style guidance:**
Expand Down

0 comments on commit d6fb70e

Please sign in to comment.