npp-usermanual's Introduction

Notepad++ User Manual

Documentation is like sex, when it's good, it's very, very good; when it's bad, it's better than nothing.

Of course, it's not our goal to create bad documentation, but you get what we mean.

Notepad++ User Manual is built collaboratively, and your contribution is very welcome. Before submitting a pull request (PR), please check our contribution rules to prevent your PR from being rejected.

Summary

How to test site locally

Notepad++ User Manual website is generated by Hugo by using hugo-book theme. In order to visualize the site (with your modification) on your computer locally, you have to download Hugo extended version firstly. Go to the root of Notepad++ User Manual repository under your bash shell (use Git bash under windows) then type HUGODIR\hugo.exe server --minify --theme book

donh@MYPC MINGW64 /c/husbandIsNotATM/npp-usermanual (adapt_hugo_book_theme)
$ /c/tmp/hugo/hugo_ext/hugo.exe server --minify --theme book
Building sites …
                   | EN
+------------------+----+
  Pages            | 23
  Paginator pages  |  0
  Non-page files   |  0
  Static files     | 14
  Processed images |  0
  Aliases          |  0
  Sitemaps         |  1
  Cleaned          |  0

Total in 69 ms
Watching for changes in C:\husbandIsNotATM\npp-usermanual\{content,themes}
Watching for config changes in C:\husbandIsNotATM\npp-usermanual\config.toml
Environment: "development"
Serving pages from memory
Running in Fast Render Mode. For full rebuilds on change: hugo server --disablastRender
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop

Type http://localhost:1313/ on the adress bar of your browser et voilà!

Recommend Projects