Skip to content

Commit 2ed2b4c

Browse files
committed
Change the structure to adapt hugo and hugo-book theme
New official site: https://npp-user-manual.org Close #21, close #22
1 parent 554cdcf commit 2ed2b4c

File tree

115 files changed

+4652
-131
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

115 files changed

+4652
-131
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
public/
2+
resources/

README.md

Lines changed: 52 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,55 @@ Of course, it's not our goal to create bad documentation, but you get what we me
1212
Summary
1313
=======
1414

15-
* [Getting started](content/getting-started/)
16-
* [Programing Languages](content/programing-languages/)
17-
* [User Defined Language System](content/user-defined-language-system/)
18-
* [Searching](content/searching/)
19-
* [Session](content/session/)
20-
* [Macros](content/macros/)
21-
* [Auto-completion](content/auto-completion/)
22-
* [Function List](content/function-list/)
23-
* [Plugins](content/plugins/)
24-
* [Preferences](content/preferences/)
25-
* [Themes](content/themes/)
26-
* [Command Line Arguments](content/command-prompt/)
27-
* [Shell Extension](content/shell-extension/)
28-
* [Binary Translation](content/binary-translation/)
29-
* [Upgrading](content/upgrading/)
30-
* [Other Resources](content/other-resources/)
15+
* [Getting started](content/docs/getting-started.md)
16+
* [Programing Languages](content/docs/programing-languages.md)
17+
* [User Defined Language System](content/docs/user-defined-language-system.md)
18+
* [Searching](content/docs/searching.md)
19+
* [Session](content/docs/session.md)
20+
* [Macros](content/docs/macros.md)
21+
* [Auto-completion](content/docs/auto-completion.md)
22+
* [Function List](content/docs/function-list.md)
23+
* [Plugins](content/docs/plugins.md)
24+
* [Preferences](content/docs/preferences.md)
25+
* [Themes](content/docs/themes.md)
26+
* [Command Line Arguments](content/docs/command-prompt.md)
27+
* [Shell Extension](content/docs/shell-extension.md)
28+
* [Binary Translation](content/docs/binary-translation.md)
29+
* [Upgrading](content/docs/upgrading.md)
30+
* [Other Resources](content/docs/other-resources.md)
31+
32+
33+
How to test site locally
34+
=======
35+
36+
**Notepad++ User Manual** website is generated by [Hugo](https://gohugo.io/) by using [hugo-book theme](https://github.com/alex-shpak/hugo-book).
37+
In order to visualize the site (with your modification) on your computer locally, you have to download [Hugo **extended** version](https://github.com/gohugoio/hugo/releases) firstly.
38+
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`
39+
40+
```bash
41+
donh@MYPC MINGW64 /c/husbandIsNotATM/npp-usermanual (adapt_hugo_book_theme)
42+
$ /c/tmp/hugo/hugo_ext/hugo.exe server --minify --theme book
43+
Building sites …
44+
| EN
45+
+------------------+----+
46+
Pages | 23
47+
Paginator pages | 0
48+
Non-page files | 0
49+
Static files | 14
50+
Processed images | 0
51+
Aliases | 0
52+
Sitemaps | 1
53+
Cleaned | 0
54+
55+
Total in 69 ms
56+
Watching for changes in C:\husbandIsNotATM\npp-usermanual\{content,themes}
57+
Watching for config changes in C:\husbandIsNotATM\npp-usermanual\config.toml
58+
Environment: "development"
59+
Serving pages from memory
60+
Running in Fast Render Mode. For full rebuilds on change: hugo server --disablastRender
61+
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
62+
Press Ctrl+C to stop
63+
64+
```
65+
66+
Type [http://localhost:1313/](http://localhost:1313/) on the adress bar of your browser et voilà!

config.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
baseURL = "https://npp-user-manual.org/"
2+
languageCode = "en-us"
3+
title = "Notepad++ User Manual"

content/_index.en.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

content/_index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Introduction
3+
type: docs
4+
---
5+
6+
Notepad++ User Manual
7+
=======
8+
9+
***Documentation is like sex, when it's good, it's very, very good; when it's bad, it's better than nothing.***
10+
11+
Of course, it's not our goal to create bad documentation, but you get what we mean.
12+
13+
**Notepad++ User Manual** is built collaboratively, and your contribution is very welcome. Before submitting a pull request (PR), please check our [contribution rules](CONTRIBUTION.md) to prevent your PR from being rejected.
File renamed without changes.

content/binary-translation/index.md renamed to content/docs/binary-translation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ title: Binary Translation
33
weight: 140
44
---
55

6+
Coming soon
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)