50 | {{ end }}
51 | {{ end }}
52 |
53 | {{ define "book-page-link" }}
54 | {{ with .Page }}
55 |
56 | {{ partial "docs/title" . }}
57 |
58 | {{ end }}
59 | {{ end }}
60 |
--------------------------------------------------------------------------------
/themes/book/assets/_markdown.scss:
--------------------------------------------------------------------------------
1 | @import 'variables';
2 |
3 | .markdown {
4 | line-height: 1.6;
5 |
6 | h1, h2, h3, h4, h5 {
7 | font-weight: normal;
8 | line-height: 1;
9 | margin-top: 1.5em;
10 | margin-bottom: $padding-16;
11 | }
12 |
13 | // remove padding at the beginning of page
14 | > :first-child {
15 | margin-top: 0;
16 | }
17 |
18 | b, optgroup, strong {
19 | font-weight: bolder;
20 | }
21 |
22 | a {
23 | text-decoration: none;
24 |
25 | &:hover {
26 | text-decoration: underline;
27 | }
28 | }
29 |
30 | img {
31 | max-width: 100%;
32 | }
33 |
34 | code {
35 | padding: 0 $padding-4;
36 | background: $gray-200;
37 | border-radius: $border-radius;
38 | font-size: .875em;
39 | }
40 |
41 | pre {
42 | padding: $padding-16;
43 | background: $gray-100;
44 | border-radius: $border-radius;
45 | overflow-x: auto;
46 |
47 | code {
48 | padding: 0;
49 | background: none;
50 | }
51 | }
52 |
53 | blockquote {
54 | margin: $padding-16 0;
55 | padding: $padding-4 ($padding-16 - $padding-4); //to keep total left space 16dp
56 |
57 | border-left: $padding-4 solid $gray-200;
58 | border-radius: $border-radius;
59 |
60 | :first-child { margin-top: 0; }
61 | :last-child { margin-bottom: 0; }
62 | }
63 |
64 | table {
65 | overflow: auto;
66 | display: block;
67 | border-spacing: 0;
68 | border-collapse: collapse;
69 | margin-top: $padding-16;
70 | margin-bottom: $padding-16;
71 |
72 | tr th, tr td {
73 | padding: $padding-8 $padding-16;
74 | line-height: 1;
75 | border: $padding-1 solid $gray-200;
76 | }
77 |
78 | tr:nth-child(2n) {
79 | background: $gray-100;
80 | }
81 | }
82 |
83 | hr {
84 | height: $padding-1;
85 | border: none;
86 | background: $gray-200;
87 | }
88 |
89 | ul, ol {
90 | padding-left: $padding-16 * 2;
91 | }
92 |
93 | dl {
94 | // padding-left: $padding-16;
95 | dt {
96 | font-weight: bolder;
97 | margin-top: $padding-16;
98 | }
99 |
100 | dd {
101 | margin-left: $padding-16 * 2;
102 | }
103 | }
104 | }
105 |
--------------------------------------------------------------------------------
/themes/book/assets/_shortcodes.scss:
--------------------------------------------------------------------------------
1 | @import "variables";
2 |
3 | .markdown-inner {
4 | // Util class to remove extra margin in nested markdown content
5 | > :first-child {
6 | margin-top: 0;
7 | }
8 | > :last-child {
9 | margin-bottom: 0;
10 | }
11 | }
12 |
13 | // {{< expand "Label" "icon" >}}
14 | .book-expand {
15 | margin-top: $padding-16;
16 | margin-bottom: $padding-16;
17 |
18 | border: $padding-1 solid $gray-200;
19 | border-radius: $border-radius;
20 |
21 | overflow: hidden;
22 |
23 | .book-expand-head {
24 | background: $gray-100;
25 | padding: $padding-8 $padding-16;
26 | cursor: pointer;
27 | }
28 |
29 | .book-expand-content {
30 | display: none;
31 | padding: $padding-16;
32 | }
33 |
34 | input[type="checkbox"]:checked + .book-expand-content {
35 | display: block;
36 | }
37 | }
38 |
39 | // {{< tabs >}}
40 | .book-tabs {
41 | margin-top: $padding-16;
42 | margin-bottom: $padding-16;
43 |
44 | border: $padding-1 solid $gray-200;
45 | border-radius: $border-radius;
46 |
47 | overflow: hidden;
48 |
49 | display: flex;
50 | flex-wrap: wrap;
51 |
52 | label {
53 | display: inline-block;
54 | padding: $padding-8 $padding-16;
55 | border-bottom: $padding-1 transparent;
56 | cursor: pointer;
57 | }
58 |
59 | .book-tabs-content {
60 | order: 999; //Move content blocks to the end
61 | width: 100%;
62 | border-top: $padding-1 solid $gray-100;
63 | padding: $padding-16;
64 | display: none;
65 | }
66 |
67 | input[type="radio"]:checked + label {
68 | border-bottom: $padding-1 solid $color-link;
69 | }
70 | input[type="radio"]:checked + label + .book-tabs-content {
71 | display: block;
72 | }
73 | }
74 |
75 | // {{< columns >}}
76 | .book-columns {
77 | margin-left: -$padding-16;
78 | margin-right: -$padding-16;
79 |
80 | > div {
81 | margin: $padding-16 0;
82 | // max-width: 50%;
83 | min-width: $body-min-width * 0.66;
84 | padding: 0 $padding-16;
85 | }
86 | }
87 |
88 | // {{< button >}}
89 | a.book-btn {
90 | display: inline-block;
91 | color: $color-link !important;
92 | text-decoration: none !important;
93 | border: $padding-1 solid $color-link;
94 | border-radius: $border-radius;
95 | padding: $padding-4 $padding-16;
96 | margin-top: $padding-8;
97 | margin-bottom: $padding-8;
98 | cursor: pointer;
99 | }
100 |
--------------------------------------------------------------------------------
/themes/book/exampleSite/content/docs/server.md:
--------------------------------------------------------------------------------
1 | # Nimium sacravere cetera exorata multifidasque satia
2 |
3 | ## Datum perierunt nato
4 |
5 | Lorem markdownum. Sit en turpe, recessit nominibus et sanguis totis. Unaque
6 | cognitius docuit sensimus mutasse terra flammas. Nec nunc sustinet Coeranon
7 | figura Erecthida saepe *gestu vel*: quod mei. Docto interdum quasi labefactus
8 | nocentius miserrimus pars cum missi matrem, ipse fletus
9 | [illo](http://fuerit-cultus.net/) super.
10 |
11 | 1. Metuunt non paene iniectis licuit
12 | 2. Extemplo iugulum relictis reddidit caput
13 | 3. Frustra adspiceres viae
14 | 4. Non fluctibus civiliter pater procedit non
15 | 5. Deos spumis ille aderam semper Stygios quantum
16 | 6. Orgia hoc
17 |
18 | ## Dare hirtus cervice Cecropis
19 |
20 | Si veteris alas proelia, sic remotis in portus nisi minimae acerris carina: et
21 | ne. Crimina longis, visae, quae et cur innuba dabat Haedis non. **Multorumque**
22 | damus qua, circumtulit teli, nec cum ait, o procul miserabile cursus. Tuam
23 | Rhodanumque ipse **scelus** humum fratrem volucrumque tandem seque domus fuerat
24 | quam per quidem ululasse ab aquas vocari.
25 |
26 | 1. Inperfecta frugum sed perennis deposuit
27 | 2. Quem cortice penthea venerisque perque perque deditque
28 | 3. Cerno impete
29 |
30 | ## Daedalon inguina mea Autolycus caeleste lumina et
31 |
32 | Cupiere adulter parentum, semineces malit nec seu luce superos integer
33 | inritaturque antro cum. Aegeus sic tabe nulla satyri notissima inmensa et aquas
34 | et. Digiti quis addit *materna*, et arma tu aegide dixit. *Traxerat* ubera, fuit
35 | se cacumine praeteritae corpore esse pendentem Diana gratissima dolor generi
36 | clamoribus occupat; flavam arma. Ponat invidiosa honores.
37 |
38 | var nybble_computer_market = client_sd_webmail.margin(romGamma(nui,
39 | internet, 78) + p_malware_algorithm(thyristorCloneBare, backup,
40 | multicastingHsf));
41 | circuit(thickDesktopPpm, computer(protocol_alert(sla)));
42 | if (integrated_memory_rich(array_printer.thermistor_lock_web(
43 | camera.gnu_read_engine.third(4, rom_point_risc), piracy(
44 | paste_analyst, os, multiprocessingKilohertz)))) {
45 | click_samba = 1;
46 | }
47 |
48 | Liber virorum acervo quaecumque placabat Luna recessit utque, nox cum nymphae
49 | licet? Arce tibi commissus letalis ambo fuit bis deus? Dixit mea, non [Quid
50 | potentior osculaque](http://ibat.org/) factis opposuitque semel perspexerat
51 | posuitque parte quas [sive](http://www.est.com/seanimos).
--------------------------------------------------------------------------------
/themes/book/exampleSite/content/docs/client.md:
--------------------------------------------------------------------------------
1 | # Ista qua aera
2 |
3 | ## Tetigisse hac duc omnipotens urbis per sapiente
4 |
5 | Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
6 | stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
7 | protulit, sed sed aere valvis inhaesuro Pallas animam: qui *quid*, ignes.
8 | Miseratus fonte Ditis conubia.
9 |
10 | var mnemonicPcmcia = file;
11 | if (bookmarkMultiprocessing) {
12 | core.intranetDigitize = menu(vdslWordart(enterprise,
13 | dviRealityTeraflops));
14 | } else {
15 | portal_socket.jsp_shareware_digital = multicasting(component_uml);
16 | memory.ppc_title_hit(lunWebFormat + fontSmartphoneView, tween *
17 | default_hard, 5 + laptopMethod);
18 | wddm_tablet_null.widgetFileRate(3, leakMaskResponsive);
19 | }
20 | var siteRjSoftware = installer;
21 | html.text = address + nasSystemDns;
22 |
23 | ## Lac roratis Diomede
24 |
25 | *Aut in vivitur* quam ibi is veniebat Herculis mihi hominem! In matrem gesserit
26 | manus [coniuge silva](http://etinachus.org/cornibusalter.html) pectore simul nec
27 | felix in haud ostendit lacrimavit mora. Digna adspice temptata, Palaestina armis
28 | at crura centum tellus ni tibi Amphiona mansit, bello tibi pugnat fuit. Sidera
29 | nec ambo temporis summe tempore, falsa committere, pater horrenda, erat ast
30 | cadunt preces.
31 |
32 | 1. Ventorum pariturae cum discors fit dabat inguina
33 | 2. Armeniae viscera
34 | 3. Et monitusque boum misereri
35 | 4. Obliquaque primasque suae
36 |
37 | ## Ovaque in tendens tibi Iovis iuga
38 |
39 | Vagatur laboribus vocandus [honorque segnior
40 | inclinat](http://www.neve-tellus.io/) petentes manere ut terram fundit; sunt.
41 | Pressit eodem inmotae quasque linguam, sub famem animos dei nocte futura
42 | Laconide India. Posset iter nata negarit *limina latus postquam* serior, cum dic
43 | area iamdudum non! Et curaque [me illo](http://testudine-est.com/): addidit
44 | tuam, Cerealia, fila undae Ilithyiam proceresque tegens numero dominaeque
45 | **regna** humanis. Multo [adstringit hirsutaque](http://www.e.org/est.php)
46 | crimine postquam perfudit illis, a mutua, memorant.
47 |
48 | ## His nocte ipse cum oculorum recepta ignorat
49 |
50 | Minos ad carmina exire studiosior Talia tamen, est a hi de quae ipsa et quoniam.
51 | Se victus at unca tantae eurus Euippe Bacchumque vocantia.
52 |
53 | Ullum frena statione de at praeferret classi Acarnanum iacuit lacertis gemino;
54 | ad caperet **finiat**! Utque videt ingemuit Dulichium paravi portaque te et, tot
55 | ab caesariem sumit, vias in rerum te.
--------------------------------------------------------------------------------
/themes/book/exampleSite/content/docs/advanced.md:
--------------------------------------------------------------------------------
1 | # Vagus elidunt
2 |
3 | ## Mole et vultus populifer quaque primoque non
4 |
5 | Lorem **markdownum pignora pelle** est tota propiore conpellat pectoribus de
6 | pectora summo. Redit teque digerit hominumque toris verebor lumina non cervice
7 | subde tollit usus habet Arctonque, furores quas nec ferunt. Quoque montibus nunc
8 | caluere tempus inhospita parcite confusaque translucet patri vestro qui optatis
9 | lumine cognoscere flos nubis! Fronde ipsamque patulos Dryopen deorum.
10 |
11 | 1. Exierant elisi ambit vivere dedere
12 | 2. Duce pollice
13 | 3. Eris modo
14 | 4. Spargitque ferrea quos palude
15 |
16 | Rursus nulli murmur; hastile inridet ut ab gravi sententia! Nomine potitus
17 | silentia flumen, sustinet placuit petis in dilapsa erat sunt. [Atria
18 | tractus](http://agendo-dis.io/) malis.
19 |
20 | 1. Comas hunc haec pietate fetum procerum dixit
21 | 2. Post torum vates letum Tiresia
22 | 3. Flumen querellas
23 | 4. Arcanaque montibus omnes
24 | 5. Quidem et
25 |
26 | ## Mane refeci capiebant unda mulcebat
27 |
28 | Victa caducifer, [malo vulnere](http://www.nec.org/iactorcolonos.php) contra
29 | dicere aurato, ludit regale, voca! Retorsit colit est profanae esse virescere
30 | furit nec; iaculi [matertera](http://iugis-thalamique.com/pecus) et visa est,
31 | viribus. Divesque creatis, tecta novat collumque vulnus
32 | [est](http://canentiet.net/lateri.php), parvas. **Faces illo pepulere** tempus
33 | adest. Tendit flamma, ab opes virum sustinet, sidus sequendo urbis.
34 |
35 | var multiplatform = cifs(illegal, zip, memory) / pcbPowerJavascript;
36 | hdmi -= 3;
37 | tunneling(constant(service_fi_hyper, avatarBar), matrixUmlMbps);
38 | frequency /= nat(keyboardRecycle, programmingGnuPerl) + icfExbibyteCursor;
39 | io_dithering(-5, markup / languageShortcut - driveHtml);
40 |
41 | Iubar proles corpore raptos vero auctor imperium; sed et huic: manus caeli
42 | Lelegas tu lux. Verbis obstitit intus oblectamina fixis linguisque ausus sperare
43 | Echionides cornuaque tenent clausit possit. Omnia putatur. Praeteritae refert
44 | ausus; ferebant e primus lora nutat, vici quae mea ipse. Et iter nil spectatae
45 | vulnus haerentia iuste et exercebat, sui et.
46 |
47 | Eurytus Hector, [materna](http://mandereevincitque.net/), ipsumque ut Politen,
48 | nec, nate, ignari, vernum cohaesit sequitur. Vel **mitis temploque** vocatus,
49 | inque alis, *oculos nomen* non silvis corpore coniunx ne displicet illa.
50 | Crescunt non unus, vidit visa quantum inmiti flumina mortis facto sic: undique a
51 | alios vincula sunt iactata abdita! Suspenderat ego fuit tendit: luna, ante urbem
52 | Propoetides **parte**.
--------------------------------------------------------------------------------
/themes/book/exampleSite/content/docs/sub-section/natusque.md:
--------------------------------------------------------------------------------
1 | # Natusque putat tu vero
2 |
3 | ## Scylaceaque neve coepisse
4 |
5 | Lorem markdownum hostem et addit arbusta iacuit laetissimus medio, quae quoque
6 | faciente. Belli et fuerant fuerat, curas Abas equos sacerdos iactasque videndo
7 | tanto, sub. Et simulasse caedis, est nec acre addiderat, manet Phrygiae
8 | quisquam, ater, aura sua **deique cornua**. Bacchi *dixi* cum tollit, ad
9 | sinistra mirum, non se dis fraudare in decimo vocet. Ducunt **Acrisio sine
10 | ratem**: enim illas venti, ferit nam ora.
11 |
12 | > Crescente cernis ritusque et vertice potui, fugam conferat enim, quin te Iuno,
13 | > Calydonia! Cursum est suo lassant quam cutis virgo urbe illa auras, finem.
14 | > [Trabem est](http://www.tutus.io/) secedere Bybli laudant quercus tribuitque
15 | > relinque et cornua ora, et quoniam maledicere viscera caelobracchia omne hoc.
16 | > Metaque Arcas patet *intraverat tenet*.
17 |
18 | Silvisque primae tulisset sive sonuere, incola visa veniat temptantes spernimur
19 | et dictis se. Sub gerunt. Aqua [tantum templi](http://www.dextra.net/)
20 | peregrinis ut *aevo cuique* falsi, ibat avidae transitus.
21 |
22 | ## Modo auctor imbres est
23 |
24 | Clanis cernere monstravit illic quoque, in ignis male una deme? Alta sonanti
25 | relatus Pindo: nisi Pico edidit data tamen rurigenae avoque. Quotiens vela petis
26 | inposuit et parte utque, tempus pars contendere facturus tumidus. Flores
27 | culpavit fera retinens, vita puer publica ferebat positas.
28 |
29 | if (mashupTopologyMnemonic(70) >= domain_correction_schema) {
30 | romTeraflops = log_android;
31 | mms_vrml_alignment(keyboard, oop, computerCodec);
32 | }
33 | retina_samba_arp *= desktop_itunes_mainframe(leopard, 511935) * 88 /
34 | direct_excel(-3, infringement_bespoke_apache, cmyk);
35 | drivePowerPlay.registryAix += dma;
36 | text_data.upsOdbc = error(user(processor_token_forum) * art_ajax_ldap);
37 |
38 | Patriaque volvitur scire Naryciusque iuvenem dixit adfusique bicorni cupido.
39 | Tecumque corpore sublato, mox hostibus et muneris, non. Draconum noscit dapibus
40 | scopulis spondere lupum diro, illo ille victoque cibis; umentia spes.
41 |
42 | Alumno est postquam gracili adnuimusque ore est praemia, ulla patitur: te disce
43 | erat cruribus prosunt. Arboris illis neque, et erubuit Gallicus: iam remisit
44 | adimuntque adsuerat nolit attonitus! Torvamque sensi ut fecundo fortuna bracchia
45 | fuerant, semper de manet inseris.
46 |
47 | Ictibus in cursus in, in isque Polyxena et Solis oris pressa exclamat *in tori*
48 | lactente. [Locoque](http://est.net/et.html) iam fata Stygia lege transire.
--------------------------------------------------------------------------------
/themes/book/exampleSite/content/docs/without-toc.md:
--------------------------------------------------------------------------------
1 | ---
2 | bookToc: false
3 | ---
4 |
5 | # At me ipso nepotibus nunc celebratior genus
6 |
7 | ## Tanto oblite
8 |
9 | Lorem markdownum pectora novis patenti igne sua opus aurae feras materiaque
10 | illic demersit imago et aristas questaque posset. Vomit quoque suo inhaesuro
11 | clara. Esse cumque, per referri triste. Ut exponit solisque communis in tendens
12 | vincetis agisque iamque huic bene ante vetat omina Thebae rates. Aeacus servat
13 | admonitu concidit, ad resimas vultus et rugas vultu **dignamque** Siphnon.
14 |
15 | Quam iugulum regia simulacra, plus meruit humo pecorumque haesit, ab discedunt
16 | dixit: ritu pharetramque. Exul Laurenti orantem modo, per densum missisque labor
17 | manibus non colla unum, obiectat. Tu pervia collo, fessus quae Cretenque Myconon
18 | crate! Tegumenque quae invisi sudore per vocari quaque plus ventis fluidos. Nodo
19 | perque, fugisse pectora sorores.
20 |
21 | ## Summe promissa supple vadit lenius
22 |
23 | Quibus largis latebris aethera versato est, ait sentiat faciemque. Aequata alis
24 | nec Caeneus exululat inclite corpus est, ire **tibi** ostendens et tibi. Rigent
25 | et vires dique possent lumina; **eadem** dixit poma funeribus paret et felix
26 | reddebant ventis utile lignum.
27 |
28 | 1. Remansit notam Stygia feroxque
29 | 2. Et dabit materna
30 | 3. Vipereas Phrygiaeque umbram sollicito cruore conlucere suus
31 | 4. Quarum Elis corniger
32 | 5. Nec ieiunia dixit
33 |
34 | Vertitur mos ortu ramosam contudit dumque; placabat ac lumen. Coniunx Amoris
35 | spatium poenamque cavernis Thebae Pleiadasque ponunt, rapiare cum quae parum
36 | nimium rima.
37 |
38 | ## Quidem resupinus inducto solebat una facinus quae
39 |
40 | Credulitas iniqua praepetibus paruit prospexit, voce poena, sub rupit sinuatur,
41 | quin suum ventorumque arcadiae priori. Soporiferam erat formamque, fecit,
42 | invergens, nymphae mutat fessas ait finge.
43 |
44 | 1. Baculum mandataque ne addere capiti violentior
45 | 2. Altera duas quam hoc ille tenues inquit
46 | 3. Sicula sidereus latrantis domoque ratae polluit comites
47 | 4. Possit oro clausura namque se nunc iuvenisque
48 | 5. Faciem posuit
49 | 6. Quodque cum ponunt novercae nata vestrae aratra
50 |
51 | Ite extrema Phrygiis, patre dentibus, tonso perculit, enim blanda, manibus fide
52 | quos caput armis, posse! Nocendo fas Alcyonae lacertis structa ferarum manus
53 | fulmen dubius, saxa caelum effuge extremis fixum tumor adfecit **bella**,
54 | potentes? Dum nec insidiosa tempora tegit
55 | [spirarunt](http://mihiferre.net/iuvenes-peto.html). Per lupi pars foliis,
56 | porreximus humum negant sunt subposuere Sidone steterant auro. Memoraverit sine:
57 | ferrum idem Orion caelum heres gerebat fixis?
58 |
--------------------------------------------------------------------------------
/content/docs/ghost-typing.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Ghost Typing
3 | weight: 145
4 | ---
5 |
6 | Ghost typing can be used to launch Notepad++ with an auto-typing text. Use command line arguments **-qn**, **-qt** or **-qf** to trigger it.
7 |
8 | ## Syntax
9 |
10 | ### Main Ghost Typing Modes
11 |
12 | Use one of these three command-line options to enable the various modes of ghost typing.
13 |
14 | `notepad++.exe -qn="EasterEggName"`
15 |
16 | **-qn**: ghost typing text is derived from a builtin easter egg text.
17 |
18 | ***EasterEggName***: the name of easter egg. Quotes are required if the name contains a space.
19 |
20 | Use `-qn=random` to randomly select an easter egg quote. Other than that, we encourage examining
21 | the source code to discover more easter egg quotes.
22 |
23 |
24 | `notepad++.exe -qt="Text" [-qSpeedX] [-lLang]`
25 |
26 | **-qt**: ghost typing text is derived from the string passed to this option.
27 |
28 | ***Text***: given text. Quotes are required if there are spaces in the text.
29 |
30 |
31 | `notepad++.exe -qf="ContentFilePath" [-qSpeedX] [-lLang]`
32 |
33 | **-qf**: quote by file.
34 |
35 | ***ContentFilePath***: The path of file, absolute or relative. If there are spaces in the directory or filename, use quotes around the whole path. The content (in ASCII or Unicode) of the file will be shown.
36 |
37 | ### Ghost Typing Options
38 |
39 | These options apply to any of the ghost typing modes, unless otherwise mentioned.
40 |
41 | **-qSpeed*****X*** : optional; ignored when using -qn. Use this flag if you want to control your display speed. ***X*** could be 1 (slow), 2 (fast) or 3 (fastest).
42 |
43 | **-l*****Lang*** : optional; ignored when using -qn. It will make ghost typing apply the syntax highlighting of the specified ***Lang***.
44 |
45 | ## Samples
46 |
47 | `notepad++.exe -qn=random`
48 |
49 | `notepad++.exe -qn="Bill Gates"`
50 |
51 | `notepad++.exe -qt="Test of ghost typing example." -qSpeed1`
52 |
53 | `notepad++.exe -qf="myFile.txt"`
54 |
55 | `notepad++.exe -qf="myVeryLongFile.txt" -qSpeed3`
56 |
57 | `notepad++.exe -qf="C:\my folder\my poetries.txt"`
58 |
59 | `notepad++.exe -qt="#hulk { height: 200%; width: 200%; color: green; }" -lcss`
60 |
61 | ## Historical Syntax
62 |
63 | The syntax listed above is valid for Notepad++ v7.9.2 and newer.
64 |
65 | In Notepad++ v7.9.1 and earlier, there were differnces in the syntax:
66 |
67 | * the command-line options for the ghost typing modes did not use the `=`,
68 | so it would be interpreted as literal text (part of the value)
69 | * quotes were interpreted as literal text (part of the value)
70 | * the sequence `%20` was used to represent a space, since you could not
71 | use quotes to make spaces significant.
72 |
73 | Keep these differences in mind if using older versions of Notepad++.
74 |
75 |
--------------------------------------------------------------------------------
/content/docs/programing-languages.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Programming Languages
3 | weight: 10
4 | ---
5 |
6 | ## Supported Programming Languages
7 |
8 | Almost 80 Programming Languages are supported by Notepad++:
9 |
10 | | | | | | |
11 | |--------------|--------------------|------------------------|---------------|---------------|
12 | | ActionScript | Ada | ASN.1 | ASP | Assembly |
13 | | AutoIt | AviSynth scripts | BaanC | batch files | Blitz Basic |
14 | | C | C# | C++ | Caml | CMake |
15 | | Cobol | CoffeeScript | Csound | CSS | D |
16 | | Diff | Erlang | escript | Forth | Fortran |
17 | | FreeBASIC | Gui4Cli | Haskell | HTML | INI files |
18 | | Intel HEX | Inno Setup scripts | Java | JavaScript | JSON |
19 | | JSP | KiXtart | LaTeX | LISP | Lua |
20 | | Makefile | Matlab | MMIX | Nim | nnCron |
21 | | NSIS scripts | Objective-C | OScript | Pascal | Perl |
22 | | PHP | PostScript | PowerShell | PureBasic | Python |
23 | | R | Rebol | Registry script (.reg) | Resource file | Ruby |
24 | | Rust | Scheme | Shell script | Smalltalk | SPICE |
25 | | SQL | Swift | S-Record | Tcl | Tektronix HEX |
26 | | TeX | txt2tags | Visual Basic | Visual Prolog | VHDL |
27 | | Verilog | XML | YAML | | |
28 |
29 |
30 | For these languages, Notepad++ supports [syntax highlighting](../preferences/#style-configurator) (customizable),
31 | syntax folding, [auto-completion](../auto-completion/) (customizable),
32 | [function list](../function-list/) (customizable via PCRE in xml file).
33 |
34 | If your beloved language is not in the list above, you can define it yourself easily, by using the
35 | [User Defined Languages System](../user-defined-language-system/). If that doesn't meet your needs,
36 | you could write (or have someone else write) a [lexer plugin](../plugins/#building-a-lexer-plugin).
37 |
38 | Please note that in Notepad++ v8.3 and newer, Notepad++ will no longer perform syntax highlighting
39 | \on files that are over 200MB -- this prevents extreme performance slowdown caused by trying to
40 | syntax highlight extremely large files.
41 |
--------------------------------------------------------------------------------
/themes/book/exampleSite/content/docs/sub-section/ego-numen.md:
--------------------------------------------------------------------------------
1 | # Ego numen obest
2 |
3 | ## Mors curru Iove pedibus curva humano salutem
4 |
5 | Lorem markdownum, mole, profugus. Madida ne quantus, pars verba lacrimis
6 | memorique longius cupidi ipse attrahit et. Vota liberiore rector suos fallit
7 | videor iustissimus barbara quod habet. Tantum patriaeque *omnia spectes* inimica
8 | mari nec spemque ululare: nuper quodque, sic, quo.
9 |
10 | var php_wireless = 4;
11 | siteWinsock.switch_inbox += so_control_logic;
12 | if (target_website.bugCopyrightIcs.cms_digital_method(mca_active) >
13 | cloneScrollHttps) {
14 | https_drop_hard(97, sshPayload + autoresponder_bmp_file);
15 | hypertextCommercialBookmark = optical_impact;
16 | }
17 | architecture = userRate.unfriend(petabyteFile(irc, wave,
18 | logic_tag.impact.cookie_favorites(5, 83)), listserv, malware_cad(
19 | disk));
20 |
21 | Populi annum deprendere suae recumbis in sedem starent! Super non accedat
22 | percepitque negare inconcessisque habitare: puerum: picta. Haec natamque, in
23 | rubentem auctore quantas oetaeas **certamine** levatae sollicitumque mecum vultu
24 | obstructaque. Limina subtemen qui trepidare virgine! Enim rumor paenituit haec
25 | **crimine Melampus** sidus.
26 |
27 | ## Partem robora herbae ilice hic exspectatus tepidique
28 |
29 | Heu fugit carne, illo ex Iunonis ut tempora sacrata, adhaesi. Fallunt eque
30 | amnes!
31 |
32 | 1. Vile ille res sidera gaudebat felicia auxilium
33 | 2. Sacra curam adfusique vasti progenitore omnia nutantem
34 | 3. Quod notum spesque extentam fores in voces
35 | 4. In qualia aequo
36 | 5. Auro commoda
37 | 6. Mearum huic volucres locorum formosus
38 |
39 | ## Invidiae fidemque cogamque esset potentia Minos
40 |
41 | Sub silicem, semesaque nec, pone pariterque tendentem, in pactae suarum recurvas
42 | et contra tu minister via. Subducere tangeris neque coniunxque utque. Virga
43 | altam, mortemque: **ubi** procul, et vidi committit. Et
44 | [Alpheos](http://nivea-pavens.io/ferroclara.html)! Perfide age magna per aequor
45 | abstulerat, Boeotia sentit succincta ad linquit confugisse certae, de dignatur
46 | et!
47 |
48 | > Sic nacta saxo *crura*, iustis rorantia premens tempora lecte sumpsisse
49 | > nusquam ulvam, apta! Sed sub plumas consueta quae; tibi mihi nec committi
50 | > mundi?
51 |
52 | Ipsa dea serpentum illic; aspicit reticere Aeaciden mitto; est novis exul.
53 | Invidit senior vela, cava sed plumae vident ille ipse domo litus ac fallere
54 | lumina, nisi famem cycno.
55 |
56 | Nunc miserata admisitque [nata](http://mollibus.net/secessitnostrique), cum
57 | loco, **iacerent**, te medullas matres. Fraude tamen, prorumpit puerum primo
58 | polus regalia pampineis iungunt nec, aderis replent carituraque cervus.
59 | Primusque lapides ad inpia pedibus; non fare praeterit penetralia in pedum uror.
60 | Rapitur vivis lacrimis, vena et *dixit*.
--------------------------------------------------------------------------------
/content/docs/upgrading.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Upgrading
3 | linktitle: Upgrading
4 | weight: 150
5 | ---
6 |
7 | Notepad++ is an actively maintained piece of software, and new versions come fast. There are basically four ways to keep abreast of changes:
8 |
9 | ## Auto-Trigger
10 | If you used installation package when you originally installed, the Auto Update feature is active by default. Every 15 days auto-updater (WinGUp) will be launched for checking, and you will be notified if a new version is available. You are presented with the option of installing that newer version.
11 |
12 | ## Upgrade On-Demand
13 | Using the **? > Update Notepad++** menu command. This will check whether there is a new version and whether the safety delay is over. If so, you are presented with the opportunity to download and install the newer version.
14 |
15 | ## Upgrade Manually
16 | Going to the main website and downloading the latest installer and running it yourself. You can watch the [Announcements](https://community.notepad-plus-plus.org/category/1/announcements) category in the [Notepad++ Community Forum](https://community.notepad-plus-plus.org/) to see when new release-candidates or final versions are released.
17 |
18 | ## Download Zip Package
19 | Going to the main website and downloading the latest zipped archive. You can then use it as a separate portable version, or compare its files to another installed or portable version, so you can decide how and when to upgrade.
20 |
21 | ## No New Version Found: Safety Delay
22 | There are two reasons that would cause there to be no new version found during an auto-triggered upgrade check or an on-demand upgrade check:
23 |
24 | First, there might not be a new version.
25 |
26 | Second, if there is a new version available, it may not have been triggered for auto-update yet. In order to avoid to spreading a new version which contains regressions or critical bugs, we wait for users' feedback before triggering the auto-update, often one to two weeks. If a critical bug or regression is found, the auto-update will _not_ be triggered for that release. On the other hand, after a reasonable delay, if we are confident there are no critical issues, the auto-update will be triggered. This safety delay prevents bad bugs or regressions from being widely spread throughout the Notepad++ user-base, limiting the exposure to those users who are watching for release announcements and are willing to manually upgrade Notepad++.
27 |
28 | The safety delay will never prevent you from downloading the installer or portable zip package yourself.
29 |
30 | ## WinGUp Project
31 | The [WinGUp](http://wingup.org/) project was started for the need of Notepad++ for upgrading Notepad++ automatically. It has since become a more generic solution for updating purposes. [This project has been forked](https://github.com/notepad-plus-plus/wingup) for more Notepad++ specific need so Plugin Admin can share its basic functionalities.
32 |
--------------------------------------------------------------------------------
/themes/book/exampleSite/content/posts/hugoisforlovers.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "Getting Started with Hugo"
3 | description = ""
4 | tags = [
5 | "go",
6 | "golang",
7 | "hugo",
8 | "development",
9 | ]
10 | date = "2014-04-02"
11 | categories = [
12 | "Development",
13 | "golang",
14 | ]
15 | menu = "main"
16 | +++
17 |
18 | ## Step 1. Install Hugo
19 |
20 | Go to [Hugo releases](https://github.com/spf13/hugo/releases) and download the
21 | appropriate version for your OS and architecture.
22 |
23 | Save it somewhere specific as we will be using it in the next step.
24 |
25 | More complete instructions are available at [Install Hugo](https://gohugo.io/getting-started/installing/)
26 |
27 | ## Step 2. Build the Docs
28 |
29 | Hugo has its own example site which happens to also be the documentation site
30 | you are reading right now.
31 |
32 | Follow the following steps:
33 |
34 | 1. Clone the [Hugo repository](http://github.com/spf13/hugo)
35 | 2. Go into the repo
36 | 3. Run hugo in server mode and build the docs
37 | 4. Open your browser to http://localhost:1313
38 |
39 | Corresponding pseudo commands:
40 |
41 | git clone https://github.com/spf13/hugo
42 | cd hugo
43 | /path/to/where/you/installed/hugo server --source=./docs
44 | > 29 pages created
45 | > 0 tags index created
46 | > in 27 ms
47 | > Web Server is available at http://localhost:1313
48 | > Press ctrl+c to stop
49 |
50 | Once you've gotten here, follow along the rest of this page on your local build.
51 |
52 | ## Step 3. Change the docs site
53 |
54 | Stop the Hugo process by hitting Ctrl+C.
55 |
56 | Now we are going to run hugo again, but this time with hugo in watch mode.
57 |
58 | /path/to/hugo/from/step/1/hugo server --source=./docs --watch
59 | > 29 pages created
60 | > 0 tags index created
61 | > in 27 ms
62 | > Web Server is available at http://localhost:1313
63 | > Watching for changes in /Users/spf13/Code/hugo/docs/content
64 | > Press ctrl+c to stop
65 |
66 |
67 | Open your [favorite editor](http://vim.spf13.com) and change one of the source
68 | content pages. How about changing this very file to *fix the typo*. How about changing this very file to *fix the typo*.
69 |
70 | Content files are found in `docs/content/`. Unless otherwise specified, files
71 | are located at the same relative location as the url, in our case
72 | `docs/content/overview/quickstart.md`.
73 |
74 | Change and save this file.. Notice what happened in your terminal.
75 |
76 | > Change detected, rebuilding site
77 |
78 | > 29 pages created
79 | > 0 tags index created
80 | > in 26 ms
81 |
82 | Refresh the browser and observe that the typo is now fixed.
83 |
84 | Notice how quick that was. Try to refresh the site before it's finished building. I double dare you.
85 | Having nearly instant feedback enables you to have your creativity flow without waiting for long builds.
86 |
87 | ## Step 4. Have fun
88 |
89 | The best way to learn something is to play with it.
90 |
--------------------------------------------------------------------------------
/themes/book/exampleSite/content/docs/with-toc.md:
--------------------------------------------------------------------------------
1 | # Caput vino delphine in tamen vias
2 |
3 | ## Cognita laeva illo fracta
4 |
5 | Lorem markdownum pavent auras, surgit nunc cingentibus libet **Laomedonque que**
6 | est. Pastor [An](http://est.org/ire.aspx) arbor filia foedat, ne [fugit
7 | aliter](http://www.indiciumturbam.org/moramquid.php), per. Helicona illas et
8 | callida neptem est *Oresitrophos* caput, dentibus est venit. Tenet reddite
9 | [famuli](http://www.antro-et.net/) praesentem fortibus, quaeque vis foret si
10 | frondes *gelidos* gravidae circumtulit [inpulit armenta
11 | nativum](http://incurvasustulit.io/illi-virtute.html).
12 |
13 | 1. Te at cruciabere vides rubentis manebo
14 | 2. Maturuit in praetemptat ruborem ignara postquam habitasse
15 | 3. Subitarum supplevit quoque fontesque venabula spretis modo
16 | 4. Montis tot est mali quasque gravis
17 | 5. Quinquennem domus arsit ipse
18 | 6. Pellem turis pugnabant locavit
19 |
20 | ## Natus quaerere
21 |
22 | Pectora et sine mulcere, coniuge dum tincta incurvae. Quis iam; est dextra
23 | Peneosque, metuis a verba, primo. Illa sed colloque suis: magno: gramen, aera
24 | excutiunt concipit.
25 |
26 | > Phrygiae petendo suisque extimuit, super, pars quod audet! Turba negarem.
27 | > Fuerat attonitus; et dextra retinet sidera ulnas undas instimulat vacuae
28 | > generis? *Agnus* dabat et ignotis dextera, sic tibi pacis **feriente at mora**
29 | > euhoeque *comites hostem* vestras Phineus. Vultuque sanguine dominoque [metuit
30 | > risi](http://iuvat.org/eundem.php) fama vergit summaque meus clarissimus
31 | > artesque tinguebat successor nominis cervice caelicolae.
32 |
33 | ## Limitibus misere sit
34 |
35 | Aurea non fata repertis praerupit feruntur simul, meae hosti lentaque *citius
36 | levibus*, cum sede dixit, Phaethon texta. *Albentibus summos* multifidasque
37 | iungitur loquendi an pectore, mihi ursaque omnia adfata, aeno parvumque in animi
38 | perlucentes. Epytus agis ait vixque clamat ornum adversam spondet, quid sceptra
39 | ipsum **est**. Reseret nec; saeva suo passu debentia linguam terga et aures et
40 | cervix [de](http://www.amnem.io/pervenit.aspx) ubera. Coercet gelidumque manus,
41 | doluit volvitur induta?
42 |
43 | ## Enim sua
44 |
45 | Iuvenilior filia inlustre templa quidem herbis permittat trahens huic. In
46 | cruribus proceres sole crescitque *fata*, quos quos; merui maris se non tamen
47 | in, mea.
48 |
49 | ## Germana aves pignus tecta
50 |
51 | Mortalia rudibusque caelum cognosceret tantum aquis redito felicior texit, nec,
52 | aris parvo acre. Me parum contulerant multi tenentem, gratissime suis; vultum tu
53 | occupat deficeret corpora, sonum. E Actaea inplevit Phinea concepit nomenque
54 | potest sanguine captam nulla et, in duxisses campis non; mercede. Dicere cur
55 | Leucothoen obitum?
56 |
57 | Postibus mittam est *nubibus principium pluma*, exsecratur facta et. Iunge
58 | Mnemonidas pallamque pars; vere restitit alis flumina quae **quoque**, est
59 | ignara infestus Pyrrha. Di ducis terris maculatum At sede praemia manes
60 | nullaque!
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | Notepad++ User Manual
2 | =======
3 |
4 | ***Documentation is like sex, when it's good, it's very, very good; when it's bad, it's better than nothing.***
5 |
6 | Of course, it's not our goal to create bad documentation, but you get what we mean.
7 |
8 | [**Notepad++ User Manual**](https://npp-user-manual.org) 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.
9 |
10 |
11 |
12 | Summary
13 | =======
14 |
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 | * [Editing](content/docs/editing.md)
19 | * [Searching](content/docs/searching.md)
20 | * [Session](content/docs/session.md)
21 | * [Macros](content/docs/macros.md)
22 | * [Auto-completion](content/docs/auto-completion.md)
23 | * [Function List](content/docs/function-list.md)
24 | * [Plugins](content/docs/plugins.md)
25 | * [Plugin Communication](content/docs/plugin-communication.md)
26 | * [Preferences](content/docs/preferences.md)
27 | * [Views](content/docs/views.md)
28 | * [Themes](content/docs/themes.md)
29 | * [Configuration Files Details](content/docs/config-files.md)
30 | * [Command Line Arguments](content/docs/command-prompt.md)
31 | * [Shell Extension](content/docs/shell-extension.md)
32 | * [Binary Translation](content/docs/binary-translation.md)
33 | * [Ghost Typing](content/docs/ghost-typing.md)
34 | * [Upgrading](content/docs/upgrading.md)
35 | * [Other Resources](content/docs/other-resources.md)
36 | * [Copyright & License](content/docs/license.md)
37 |
38 |
39 | How to test site locally
40 | =======
41 |
42 | **Notepad++ User Manual** website is generated by [Hugo](https://gohugo.io/) by using [hugo-book theme](https://github.com/alex-shpak/hugo-book).
43 | 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.
44 | 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`
45 |
46 | ```txt
47 | donh@MYPC MINGW64 /c/husbandIsNotATM/npp-usermanual (adapt_hugo_book_theme)
48 | $ /c/tmp/hugo/hugo_ext/hugo.exe server --minify --theme book
49 | Building sites …
50 | | EN
51 | +------------------+----+
52 | Pages | 23
53 | Paginator pages | 0
54 | Non-page files | 0
55 | Static files | 14
56 | Processed images | 0
57 | Aliases | 0
58 | Sitemaps | 1
59 | Cleaned | 0
60 |
61 | Total in 69 ms
62 | Watching for changes in C:\husbandIsNotATM\npp-usermanual\{content,themes}
63 | Watching for config changes in C:\husbandIsNotATM\npp-usermanual\config.toml
64 | Environment: "development"
65 | Serving pages from memory
66 | Running in Fast Render Mode. For full rebuilds on change: hugo server --disablastRender
67 | Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
68 | Press Ctrl+C to stop
69 |
70 | ```
71 |
72 | Type [http://localhost:1313/](http://localhost:1313/) on the adress bar of your browser et voilà!
73 |
--------------------------------------------------------------------------------
/themes/book/exampleSite/content/_index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Introduction
3 | type: docs
4 | ---
5 |
6 | # Acerbo datus maxime
7 |
8 | {{< columns >}}
9 | ## Astris ipse furtiva
10 |
11 | Est in vagis et Pittheus tu arge accipiter regia iram vocatur nurus. Omnes ut
12 | olivae sensit **arma sorori** deducit, inesset **crudus**, ego vetuere aliis,
13 | modo arsit? Utinam rapta fiducia valuere litora _adicit cursu_, ad facies
14 |
15 | <--->
16 |
17 | ## Suis quot vota
18 |
19 | Ea _furtique_ risere fratres edidit terrae magis. Colla tam mihi tenebat:
20 | miseram excita suadent es pecudes iam. Concilio _quam_ velatus posset ait quod
21 | nunc! Fragosis suae dextra geruntur functus vulgata.
22 | {{< /columns >}}
23 |
24 |
25 | ## Tempora nisi nunc
26 |
27 | Lorem **markdownum** emicat gestu. Cannis sol pressit ducta. **Est** Idaei,
28 | tremens ausim se tutaeque, illi ulnis hausit, sed, lumina cutem. Quae avis
29 | sequens!
30 |
31 | var panel = ram_design;
32 | if (backup + system) {
33 | file.readPoint = network_native;
34 | sidebar_engine_device(cell_tftp_raster,
35 | dual_login_paper.adf_vci.application_reader_design(
36 | graphicsNvramCdma, lpi_footer_snmp, integer_model));
37 | }
38 | public_keyboard_docking += error.controller_gibibyte_plug.ip(4,
39 | asciiPetaflops, software(supercomputer_compatible_status + 4));
40 | dynamic_disk.indexModeLaptop = bufferTftpReality;
41 | var export_vlog_sequence = trinitron_flowchart + supercomputer_cluster_rj(
42 | -1, toolbar_powerpoint_query, -2 / multiprocessing_impression);
43 |
44 | ## Locis suis novi cum suoque decidit eadem
45 |
46 | Idmoniae ripis, at aves, ali missa adest, ut _et autem_, et ab? Venit spes
47 | versus finis sermonibus patefecit murum nec est sine oculis. _Ille_ inmota
48 | macies domoque caelestia cadit tantummodo scelus procul, corde!
49 |
50 | 1. Dolentem capi parte rostro alvum habentem pudor
51 | 2. Fulgentia sanguine paret
52 | 3. E punior consurgit lentus
53 | 4. Vox hasta eras micantes
54 |
55 | ## Facibus pharetrae indetonsusque indulsit sic incurrite foliis
56 |
57 | Nefandam et prisci palmas! Blandita cutis flectitur montis macies, te _nati_
58 | Latiis; turbaque inferias. Virginis tibi peracta avidusque facies caper nec, e
59 | at ademptae, mira.
60 |
61 | direct *= font(inputScareware(sliHome), crossplatform.byte(
62 | ppl_encryption.excel_e_rte(integratedModelModifier), timeVirtual,
63 | floating_speakers.media_printer(us, yahoo, primaryPhp)));
64 | friendly_metal_flatbed(cd, isoPrimaryStorage(reader), dmaMirrored);
65 | if (parse_flash_cron.metalGif(1, adServiceDevice, utility)) {
66 | adf -= operation_cdma_samba;
67 | imapGif.switch += torrent;
68 | } else {
69 | pmu.disk_captcha = digital_ppp_pci + recursionTransistor(5, dram);
70 | ajax_service += grayscalePythonLock;
71 | google_scroll_capacity = ftp + engine_dslam_sidebar / tape - 1;
72 | }
73 | drive_rw = zipTftp;
74 | var suffix = software_router_extension.dimm_ddr(-5,
75 | kernel_digital_minisite);
76 |
77 | Vocavit toto; alas **mitis** maestus in liquidarum ab legi finitimosque dominam
78 | tibi subitus; Orionis vertitur nota. Currere alti etiam seroque cernitis
79 | innumeris miraturus amplectique collo sustinet quemque! Litora ante turba?
80 |
--------------------------------------------------------------------------------
/themes/book/exampleSite/content/docs/examples.md:
--------------------------------------------------------------------------------
1 | # Ubi loqui
2 |
3 | ## Mentem genus facietque salire tempus bracchia
4 |
5 | Lorem markdownum partu paterno Achillem. Habent amne generosi aderant ad pellem
6 | nec erat sustinet merces columque haec et, dixit minus nutrit accipiam subibis
7 | subdidit. Temeraria servatum agros qui sed fulva facta. Primum ultima, dedit,
8 | suo quisque linguae medentes fixo: tum petis.
9 |
10 | ## Rapit vocant si hunc siste adspice
11 |
12 | Ora precari Patraeque Neptunia, dixit Danae [Cithaeron
13 | armaque](http://mersis-an.org/litoristum) maxima in **nati Coniugis** templis
14 | fluidove. Effugit usus nec ingreditur agmen *ac manus* conlato. Nullis vagis
15 | nequiquam vultibus aliquos altera *suum venis* teneas fretum. Armos [remotis
16 | hoc](http://tutum.io/me) sine ferrea iuncta quam!
17 |
18 | ## Locus fuit caecis
19 |
20 | Nefas discordemque domino montes numen tum humili nexilibusque exit, Iove. Quae
21 | miror esse, scelerisque Melaneus viribus. Miseri laurus. Hoc est proposita me
22 | ante aliquid, aura inponere candidioribus quidque accendit bella, sumpta.
23 | Intravit quam erat figentem hunc, motus de fontes parvo tempestate.
24 |
25 | iscsi_virus = pitch(json_in_on(eupViral),
26 | northbridge_services_troubleshooting, personal(
27 | firmware_rw.trash_rw_crm.device(interactive_gopher_personal,
28 | software, -1), megabit, ergonomicsSoftware(cmyk_usb_panel,
29 | mips_whitelist_duplex, cpa)));
30 | if (5) {
31 | managementNetwork += dma - boolean;
32 | kilohertz_token = 2;
33 | honeypot_affiliate_ergonomics = fiber;
34 | }
35 | mouseNorthbridge = byte(nybble_xmp_modem.horse_subnet(
36 | analogThroughputService * graphicPoint, drop(daw_bit, dnsIntranet),
37 | gateway_ospf), repository.domain_key.mouse(serverData(fileNetwork,
38 | trim_duplex_file), cellTapeDirect, token_tooltip_mashup(
39 | ripcordingMashup)));
40 | module_it = honeypot_driver(client_cold_dvr(593902, ripping_frequency) +
41 | coreLog.joystick(componentUdpLink), windows_expansion_touchscreen);
42 | bashGigabit.external.reality(2, server_hardware_codec.flops.ebookSampling(
43 | ciscNavigationBacklink, table + cleanDriver), indexProtocolIsp);
44 |
45 | ## Placabilis coactis nega ingemuit ignoscat nimia non
46 |
47 | Frontis turba. Oculi gravis est Delphice; *inque praedaque* sanguine manu non.
48 |
49 | if (ad_api) {
50 | zif += usb.tiffAvatarRate(subnet, digital_rt) + exploitDrive;
51 | gigaflops(2 - bluetooth, edi_asp_memory.gopher(queryCursor, laptop),
52 | panel_point_firmware);
53 | spyware_bash.statePopApplet = express_netbios_digital(
54 | insertion_troubleshooting.brouter(recordFolderUs), 65);
55 | }
56 | recursionCoreRay = -5;
57 | if (hub == non) {
58 | portBoxVirus = soundWeb(recursive_card(rwTechnologyLeopard),
59 | font_radcab, guidCmsScalable + reciprocalMatrixPim);
60 | left.bug = screenshot;
61 | } else {
62 | tooltipOpacity = raw_process_permalink(webcamFontUser, -1);
63 | executable_router += tape;
64 | }
65 | if (tft) {
66 | bandwidthWeb *= social_page;
67 | } else {
68 | regular += 611883;
69 | thumbnail /= system_lag_keyboard;
70 | }
71 |
72 | ## Caesorum illa tu sentit micat vestes papyriferi
73 |
74 | Inde aderam facti; Theseus vis de tauri illa peream. Oculos **uberaque** non
75 | regisque vobis cursuque, opus venit quam vulnera. Et maiora necemque, lege modo;
76 | gestanda nitidi, vero? Dum ne pectoraque testantur.
77 |
78 | Venasque repulsa Samos qui, exspectatum eram animosque hinc, [aut
79 | manes](http://www.creveratnon.net/apricaaetheriis), Assyrii. Cupiens auctoribus
80 | pariter rubet, profana magni super nocens. Vos ius sibilat inpar turba visae
81 | iusto! Sedes ante dum superest **extrema**.
--------------------------------------------------------------------------------
/content/docs/macros.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Task automation with macros
3 | linktitle: Macros
4 | weight: 60
5 | ---
6 |
7 | Notepad++ is capable of recording some of your actions you perform while editing
8 | a document, and replaying those later on to avoid having to repeat that sequence
9 | of actions. This is called a macro and can save a great deal of time. Macros
10 | can be played once, or multiple times, even as long as is required to run through
11 | an entire document. You can save them for later use and assign keystrokes to
12 | them for fast access (See [Shortcut Mapper](../preferences/#shortcut-mapper)).
13 | Macros are sensitive to the current position of the caret and will (normally
14 | speaking) operate relative to it.
15 |
16 |
17 | ## Record a macro
18 |
19 | To record a macro, select **Macro > Start Recording** or press the button on the
20 | toolbar. Notepad++ will now keep track of the changes you make on a document or
21 | certain actions you perform.
22 |
23 | To stop recording, select **Macro > Stop Recording** or select the button on the
24 | toolbar. As an exception to most commands, you can toggle this behavior with a
25 | special shortcut combination that is not listed in the menu but solely in the
26 | Shortcut mapper (see [Shortcut Mapper](../preferences/#shortcut-mapper)).
27 | By default, this is the combination Ctrl-Shift-R.
28 |
29 | After the recording is stopped, it will be stored in a temporary buffer. If you
30 | haven't performed any actions during the recording, this buffer will be cleared. If you start
31 | recording another macro without saving your earlier work, it will be lost.
32 |
33 |
34 | ## Play a recoded macro
35 |
36 | To play the macro in the buffer, select **Macro > Playback** or press the button.
37 | This will perform the macro once at the current position.
38 |
39 |
40 | ## Save a recorded macro
41 |
42 | To save the macro in the buffer, select **Macro > Save current recorded macro** or
43 | press the toolbar button. A dialog will pop up asking for a name of the macro and the
44 | default key combination. These can later be changed (or deleted) using
45 | **Macro > Modify Shortcut / Delete Macro**, which brings up the
46 | [**Settings > Shortcut Mapper**](../preferences/#shortcut-mapper) on the **Macros** tab.
47 | When saved, the macro will be available in the bottom section of the **Macro** menu, or
48 | from the pulldown in the dialog accessed from the **Macro > Run a Macro Multiple Times**
49 | menu entry.
50 |
51 | As noted in the [Configuration Files](../config-files) documentation, Notepad++
52 | writes the configuration files (including the macros) when it exits, which means that
53 | after you save your macro, your new macro will _not_ be written to the `shortcuts.xml`
54 | configuration file until Notepad++ exits. Thus, if you open `shortcuts.xml` after saving
55 | the macro but before exiting Notepad++, you will _not_ be able to see your new macro yet.
56 |
57 | ## Play a recoded macro multiple times
58 |
59 | To play the current macro in the buffer or any saved macro once or multiple
60 | times, select **Macro > Run a Macro Multiple Times**... or press the button.
61 | A dialog will pop up allowing you to select what macro to perform (buffer
62 | macro or any saved macro) and how many times. You can also opt to perform the
63 | macro until the caret reaches the end of the current file (starting from
64 | its current position).
65 |
66 | Note that if no macros are available, this menu option is greyed out, and
67 | the dialog is inaccessible.
68 |
69 |
70 | ## Edit or delete an existing macro shortcut
71 |
72 | To edit or delete an existing macro shortcut, you can use the Shortcut mapper,
73 | which displays all shortcuts of all kinds, and allows changing or removing a key
74 | binding. The interface is also available through the **Macro > Modify
75 | shortcut / Delete macro** menu entry.
76 |
77 | The contents of a macro definition can be edited only in the `shortcuts.xml`
78 | file: there is no built-in interface in Notepad++. For more information on
79 | the details of how the macros are stored, and the syntax involved, see the
80 | [**Configuration Files Details**: **** section](../config-files/#macros).
81 |
--------------------------------------------------------------------------------
/CONTRIBUTION.md:
--------------------------------------------------------------------------------
1 | # Contribution
2 |
3 |
4 | ## Pull Requests (PR)
5 |
6 | Your pull requests are welcome to suggest changes to the user manual.
7 |
8 | ### Guidelines for pull requests
9 |
10 | * *KISS* - Keep It Simple, Stupid. Fewer changes per PR are better.
11 | * Respect Notepad++ User Manual style.
12 | * It is best if there is an open [issue](../../issues) before making changes and submitting a PR, so that you can ask whether your idea is worth incorporating before spending the effort on.
13 | * You will need to create a fork to make changes. Create a new branch in your fork for each PR, keeping each PR independent of others you submit.
14 |
15 | If these guidelines and style guide are not followed, or if the reviewers otherwise do not believe the submitted changes are appropriate, you may be asked to make changes to your PR, or your PR may be rejected. If you do not make requested changes, the reviewers may edit or reject the PR. We reserve the right to reject a PR for any reason, not just for a reason explicitly enumerated in this document.
16 |
17 | ## Style Guide
18 |
19 | * First and foremost, when editing, keep it similar to what's already in that document.
20 | * Do not arbitrarily change an existing style choice (like `-` vs `*` for bulleted lists, or `_..._` vs `*...*` for italics) without a good technical reason
21 | * If you are fixing an actual Markdown _error_ that causes the final user manual documentation to render incorrectly, that is allowed (and encouraged).
22 |
23 | * When referencing a menu item, like **File > Open**, make it bold, and use `>` as the separator-character between different levels.
24 |
25 | * When referencing a setting in a dialog box, make it bold. Examples:
26 | * On the **Settings > Preferences > Backup** page, please enable **☑ Remember Current Session For Next Launch**"
27 | * Use the checkbox **Search > Find > Search Mode: ☑ Regular Expression** to enable regular expressions in your search
28 |
29 | * For text that you want to indicate as user-entered (such as regular expressions or values entered into dialog box prompts), and for filenames and directories, use backticks to set the `monospaced / code` formatting.
30 |
31 | * Special symbols may be entered by pasting in Unicode characters. Please stick to common characters that are likely to be rendered on a variety of platforms with a variety of fonts.
32 |
33 | * Images should be used sparingly. If they are needed, keep the filesize small and place the image file in the `content/docs/images/` directory.
34 |
35 | * Changes to the theme (whether it's just slight edits or a completely new theme, or anything in between) will not be accepted unless you have worked with the owner to make sure that the changes to the theme are necessary or appropriate.
36 |
37 | ## Cross-Links
38 |
39 | * To link from one page in the user-manual docs to the top of another page, use the syntax `[link name](../page/)` . *Note* that in the link syntax, `page` does _not_ include the `.md` extension.
40 |
41 | * To link to an anchor (like a heading) in another file, use `[link name](../page/#anchor)` ; or use `[link name](#anchor)` to link to an anchor (heading) in the same file. The anchor names are the lower-case version of the section headers, with spaces replaced by hyphens.
42 |
43 | * Example: from the [Themes](content/docs/themes/) page, you can link to the [**Preferences > Style Configurator**](content/docs/preferences/#style-configurator) using the syntax `[**Preferences > Style Configurator**](../preferences/#style-configurator)`.
44 |
45 | ## Keep PRs independent
46 |
47 | If you are making multiple PRs, please make sure you keep them separate. If you make a first change to change A to B and submit it as PR #N, then using the same branch (or a new branch that started from the first branch) and change C to D and submit as PR #M, then PR #M will contain the same changes as #N, in addition to the new changes. This will mean that if #N is rejected, #M will likely be rejected as well (because they contain the same changes that were rejected); and if #N is accepted (possibly with changes from the maintainers), then #M might come in conflict with #N; this also makes it harder to evaluate specifically what was intended for PR #M.
48 |
49 | The best way to avoid this problem is to
50 | 1. Fork from the main repository, or sync your existing fork with the main repository using GitHub's **Fetch Upstream > Fetch and Merge** feature
51 | 2. Before making any new changes, create a branch specific to the one issue you are trying to fix
52 | 3. Make those changes and submit a new PR from the _branch_ back to the main repository
53 | 4. If you want to make changes for another issue before the PR from step#3 was accepted and merged, create a new branch from your unmodified fork, so that it's starting from the same state that the main repository is currently in
54 | 5. Make the changes in the new branch, and submit a PR from that branch to the main repository
55 | 6. Now your PRs from #3 and #5 are independent, and #5 won't repeat or interfere with the changes from #3
56 |
57 | If PRs are not kept independent, they may be rejected.
58 |
--------------------------------------------------------------------------------
/themes/book/exampleSite/content/docs/shortcodes.md:
--------------------------------------------------------------------------------
1 | # Shortcodes
2 |
3 | ## Expand shortcode
4 |
5 | ### Default
6 |
7 | ```tpl
8 | {{}}
9 | ## Markdown content
10 | Lorem markdownum insigne...
11 | {{}}
12 | ```
13 |
14 | {{< expand >}}
15 | ## Markdown content
16 | Lorem markdownum insigne...
17 | {{< /expand >}}
18 |
19 | ### With Custom Label
20 |
21 | ```tpl
22 | {{}}
23 | ## Markdown content
24 | Lorem markdownum insigne...
25 | {{}}
26 | ```
27 |
28 | {{< expand "Custom Label" "..." >}}
29 | ## Markdown content
30 | Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
31 | stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
32 | protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
33 | Miseratus fonte Ditis conubia.
34 | {{< /expand >}}
35 |
36 | ## Buttons
37 |
38 | ```tpl
39 | {{}}Get Home{{}}
40 | {{}}Contribute{{}}
41 | ```
42 |
43 | {{< button relref="/" >}}Get Home{{< /button >}}
44 | {{< button href="https://github.com/alex-shpak/hugo-book" >}}Contribute{{< /button >}}
45 |
46 | ## Tabs
47 |
48 | ```tpl
49 | {{}}
50 | {{}} # MacOS Content {{}}
51 | {{}} # Linux Content {{}}
52 | {{}} # Windows Content {{}}
53 | {{}}
54 | ```
55 |
56 | {{< tabs "uniqueid" >}}
57 | {{< tab "MacOS" >}}
58 | # MacOS
59 |
60 | This is tab **MacOS** content.
61 |
62 | Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
63 | stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
64 | protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
65 | Miseratus fonte Ditis conubia.
66 | {{< /tab >}}
67 |
68 | {{< tab "Linux" >}}
69 |
70 | # Linux
71 |
72 | This is tab **Linux** content.
73 |
74 | Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
75 | stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
76 | protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
77 | Miseratus fonte Ditis conubia.
78 | {{< /tab >}}
79 |
80 | {{< tab "Windows" >}}
81 |
82 | # Windows
83 |
84 | This is tab **Windows** content.
85 |
86 | Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
87 | stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
88 | protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
89 | Miseratus fonte Ditis conubia.
90 | {{< /tab >}}
91 | {{< /tabs >}}
92 |
93 | ## Columns
94 |
95 | ```html
96 | {{}}
97 | # Left Content
98 | Lorem markdownum insigne...
99 |
100 | <--->
101 |
102 | # Mid Content
103 | Lorem markdownum insigne...
104 |
105 | <--->
106 |
107 | # Right Content
108 | Lorem markdownum insigne...
109 | {{}}
110 | ```
111 |
112 | {{< columns >}}
113 | ## Left Content
114 | Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
115 | stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
116 | protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
117 | Miseratus fonte Ditis conubia.
118 |
119 | <--->
120 |
121 | ## Mid Content
122 | Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
123 | stringit, frustra Saturnius uteroque inter!
124 |
125 | <--->
126 |
127 | ## Right Content
128 | Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
129 | stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
130 | protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
131 | Miseratus fonte Ditis conubia.
132 | {{< /columns >}}
133 |
134 |
135 | ## Mermaid Chart
136 |
137 | {{< columns >}}
138 | ```tpl
139 | {{}}
140 | sequenceDiagram
141 | Alice->>Bob: Hello Bob, how are you?
142 | alt is sick
143 | Bob->>Alice: Not so good :(
144 | else is well
145 | Bob->>Alice: Feeling fresh like a daisy
146 | end
147 | opt Extra response
148 | Bob->>Alice: Thanks for asking
149 | end
150 | {{}}
151 | ```
152 |
153 | <--->
154 |
155 | {{< mermaid >}}
156 | sequenceDiagram
157 | Alice->>Bob: Hello Bob, how are you?
158 | alt is sick
159 | Bob->>Alice: Not so good :(
160 | else is well
161 | Bob->>Alice: Feeling fresh like a daisy
162 | end
163 | opt Extra response
164 | Bob->>Alice: Thanks for asking
165 | end
166 | {{< /mermaid >}}
167 |
168 | {{< /columns >}}
169 |
170 |
171 | ## KaTeX
172 |
173 | {{< columns >}}
174 |
175 | ```latex
176 | {{}}
177 | x = \begin{cases}
178 | a &\text{if } b \\
179 | c &\text{if } d
180 | \end{cases}
181 | {{}}
182 | ```
183 |
184 | <--->
185 |
186 | {{< katex >}}
187 | x = \begin{cases}
188 | a &\text{if } b \\
189 | c &\text{if } d
190 | \end{cases}
191 | {{< /katex >}}
192 |
193 | {{< /columns >}}
194 |
195 |
196 |
--------------------------------------------------------------------------------
/themes/book/assets/book.scss:
--------------------------------------------------------------------------------
1 | @import "normalize";
2 | @import "variables";
3 | @import "utils";
4 | @import "markdown";
5 | @import "shortcodes";
6 |
7 | html {
8 | font-size: $font-size-base;
9 | letter-spacing: 0.33px;
10 | scroll-behavior: smooth;
11 | }
12 |
13 | html,
14 | body {
15 | min-width: $body-min-width;
16 | overflow-x: hidden;
17 | }
18 |
19 | body {
20 | color: $body-font-color;
21 | background: $body-background;
22 |
23 | font-family: sans-serif;
24 | font-weight: $body-font-weight;
25 |
26 | text-rendering: optimizeLegibility;
27 | -webkit-font-smoothing: antialiased;
28 | -moz-osx-font-smoothing: grayscale;
29 |
30 | box-sizing: border-box;
31 | * {
32 | box-sizing: inherit;
33 | }
34 | }
35 |
36 | h1,
37 | h2,
38 | h3,
39 | h4,
40 | h5 {
41 | font-weight: $body-font-weight;
42 | }
43 |
44 | a {
45 | text-decoration: none;
46 | color: $color-link;
47 |
48 | &:visited {
49 | color: $color-visited-link;
50 | }
51 | }
52 |
53 | img {
54 | vertical-align: baseline;
55 | }
56 |
57 | aside nav ul {
58 | padding: 0;
59 | margin: 0;
60 | list-style: none;
61 |
62 | li {
63 | margin: 1em 0;
64 | }
65 |
66 | a {
67 | display: block;
68 | }
69 |
70 | a:hover {
71 | opacity: 0.5;
72 | }
73 |
74 | ul {
75 | padding-left: $padding-16;
76 | }
77 | }
78 |
79 | ul.pagination {
80 | display: flex;
81 | justify-content: center;
82 | list-style-type: none;
83 |
84 | .page-item a {
85 | padding: $padding-16;
86 | }
87 | }
88 |
89 | .container {
90 | max-width: $container-max-width;
91 | margin: 0 auto;
92 | }
93 |
94 | .book-brand {
95 | margin-top: 0;
96 | }
97 |
98 | .book-menu {
99 | flex: 0 0 $menu-width;
100 | font-size: $font-size-14;
101 |
102 | nav {
103 | width: $menu-width;
104 | padding: $padding-16;
105 |
106 | @include fixed;
107 | }
108 |
109 | @include dark-links;
110 | }
111 |
112 | .book-section-flat {
113 | margin-bottom: $padding-16 * 2;
114 |
115 | &:not(:first-child) {
116 | margin-top: $padding-16 * 2;
117 | }
118 |
119 | > a,
120 | > span {
121 | font-weight: bolder;
122 | }
123 |
124 | > ul {
125 | padding-left: 0;
126 | }
127 | }
128 |
129 | .book-page {
130 | min-width: $body-min-width;
131 | flex-grow: 1;
132 | padding: $padding-16;
133 | }
134 |
135 | .book-header {
136 | margin-bottom: $padding-16;
137 | display: none;
138 | }
139 |
140 | .book-search {
141 | position: relative;
142 | margin: $padding-16 0;
143 | border-bottom: 1px solid transparent;
144 |
145 | &::after {
146 | display: block;
147 | content: "";
148 | clear: both;
149 | }
150 |
151 | input {
152 | width: 100%;
153 | padding: $padding-8;
154 |
155 | border: 0;
156 | border-radius: $padding-4;
157 |
158 | background: $gray-100;
159 |
160 | &:required + .book-search-spinner {
161 | display: block;
162 | }
163 | }
164 |
165 | .book-search-spinner {
166 | position: absolute;
167 | margin: $padding-8;
168 | right: 0;
169 | top: 0;
170 |
171 | width: $padding-16;
172 | height: $padding-16;
173 |
174 | border: $padding-1 solid transparent;
175 | border-top-color: $body-font-color;
176 | border-radius: 50%;
177 |
178 | @include spin(1s);
179 | }
180 | }
181 |
182 | .book-toc {
183 | flex: 0 0 $toc-width;
184 | font-size: $font-size-12;
185 |
186 | nav {
187 | width: $toc-width;
188 | padding: $padding-16;
189 |
190 | @include fixed;
191 | }
192 |
193 | img {
194 | height: 1em;
195 | }
196 |
197 | nav > ul > li:first-child {
198 | margin-top: 0;
199 | }
200 |
201 | // Classes to hide nested levels of ToC (can be replaced by @for, but it's more clear like this)
202 | &.level-1 ul ul,
203 | &.level-2 ul ul ul,
204 | &.level-3 ul ul ul ul,
205 | &.level-4 ul ul ul ul ul,
206 | &.level-5 ul ul ul ul ul ul,
207 | &.level-6 ul ul ul ul ul ul ul {
208 | display: none;
209 | }
210 | }
211 |
212 | .book-footer {
213 | display: flex;
214 | padding-top: $padding-16;
215 | font-size: $font-size-14;
216 |
217 | img {
218 | height: 1em;
219 | }
220 | }
221 |
222 | .book-posts {
223 | min-width: $body-min-width;
224 | max-width: $body-min-width * 2;
225 | flex-grow: 1;
226 | padding: $padding-16;
227 |
228 | article {
229 | padding-bottom: $padding-16;
230 | }
231 | }
232 |
233 | .book-home {
234 | padding: $padding-16;
235 | }
236 |
237 | // Responsive styles
238 | aside nav,
239 | .book-page,
240 | .book-posts,
241 | .markdown {
242 | transition: 0.2s ease-in-out;
243 | transition-property: transform, margin-left, opacity;
244 | will-change: transform, margin-left;
245 | }
246 |
247 | @media screen and (max-width: $md-breakpoint) {
248 | .book-toc {
249 | display: none;
250 | }
251 | }
252 |
253 | @media screen and (max-width: $sm-breakpoint) {
254 | .book-menu {
255 | margin-left: -$menu-width;
256 | font-size: $font-size-base;
257 | }
258 |
259 | .book-header {
260 | display: flex;
261 | }
262 |
263 | #menu-control:checked + main {
264 | .book-menu nav,
265 | .book-page,
266 | .book-posts {
267 | transform: translateX($menu-width);
268 | }
269 |
270 | .book-header label {
271 | transform: rotate(90deg);
272 | }
273 |
274 | .markdown {
275 | opacity: 0.25;
276 | }
277 | }
278 | }
279 |
280 | // Extra space for big screens
281 | @media screen and (min-width: $container-max-width) {
282 | .book-page,
283 | .book-posts,
284 | .book-menu nav,
285 | .book-toc nav {
286 | padding: $padding-16 * 2 $padding-16;
287 | }
288 | }
289 |
290 | // Add fonts
291 | @import "fonts";
292 |
293 | // Add custom defined styles
294 | @import "custom";
295 |
--------------------------------------------------------------------------------
/themes/book/exampleSite/content/posts/migrate-from-jekyll.md:
--------------------------------------------------------------------------------
1 | ---
2 | date: 2014-03-10
3 | linktitle: Migrating from Jekyll
4 | menu:
5 | main:
6 | parent: tutorials
7 | prev: /tutorials/mathjax
8 | title: Migrate to Hugo from Jekyll
9 | weight: 10
10 | ---
11 |
12 | ## Move static content to `static`
13 | Jekyll has a rule that any directory not starting with `_` will be copied as-is to the `_site` output. Hugo keeps all static content under `static`. You should therefore move it all there.
14 | With Jekyll, something that looked like
15 |
16 | ▾ /
17 | ▾ images/
18 | logo.png
19 |
20 | should become
21 |
22 | ▾ /
23 | ▾ static/
24 | ▾ images/
25 | logo.png
26 |
27 | Additionally, you'll want any files that should reside at the root (such as `CNAME`) to be moved to `static`.
28 |
29 | ## Create your Hugo configuration file
30 | Hugo can read your configuration as JSON, YAML or TOML. Hugo supports parameters custom configuration too. Refer to the [Hugo configuration documentation](/overview/configuration/) for details.
31 |
32 | ## Set your configuration publish folder to `_site`
33 | The default is for Jekyll to publish to `_site` and for Hugo to publish to `public`. If, like me, you have [`_site` mapped to a git submodule on the `gh-pages` branch](http://blog.blindgaenger.net/generate_github_pages_in_a_submodule.html), you'll want to do one of two alternatives:
34 |
35 | 1. Change your submodule to point to map `gh-pages` to public instead of `_site` (recommended).
36 |
37 | git submodule deinit _site
38 | git rm _site
39 | git submodule add -b gh-pages git@github.com:your-username/your-repo.git public
40 |
41 | 2. Or, change the Hugo configuration to use `_site` instead of `public`.
42 |
43 | {
44 | ..
45 | "publishdir": "_site",
46 | ..
47 | }
48 |
49 | ## Convert Jekyll templates to Hugo templates
50 | That's the bulk of the work right here. The documentation is your friend. You should refer to [Jekyll's template documentation](http://jekyllrb.com/docs/templates/) if you need to refresh your memory on how you built your blog and [Hugo's template](/layout/templates/) to learn Hugo's way.
51 |
52 | As a single reference data point, converting my templates for [heyitsalex.net](http://heyitsalex.net/) took me no more than a few hours.
53 |
54 | ## Convert Jekyll plugins to Hugo shortcodes
55 | Jekyll has [plugins](http://jekyllrb.com/docs/plugins/); Hugo has [shortcodes](/doc/shortcodes/). It's fairly trivial to do a port.
56 |
57 | ### Implementation
58 | As an example, I was using a custom [`image_tag`](https://github.com/alexandre-normand/alexandre-normand/blob/74bb12036a71334fdb7dba84e073382fc06908ec/_plugins/image_tag.rb) plugin to generate figures with caption when running Jekyll. As I read about shortcodes, I found Hugo had a nice built-in shortcode that does exactly the same thing.
59 |
60 | Jekyll's plugin:
61 |
62 | module Jekyll
63 | class ImageTag < Liquid::Tag
64 | @url = nil
65 | @caption = nil
66 | @class = nil
67 | @link = nil
68 | // Patterns
69 | IMAGE_URL_WITH_CLASS_AND_CAPTION =
70 | IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK = /(\w+)(\s+)((https?:\/\/|\/)(\S+))(\s+)"(.*?)"(\s+)->((https?:\/\/|\/)(\S+))(\s*)/i
71 | IMAGE_URL_WITH_CAPTION = /((https?:\/\/|\/)(\S+))(\s+)"(.*?)"/i
72 | IMAGE_URL_WITH_CLASS = /(\w+)(\s+)((https?:\/\/|\/)(\S+))/i
73 | IMAGE_URL = /((https?:\/\/|\/)(\S+))/i
74 | def initialize(tag_name, markup, tokens)
75 | super
76 | if markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK
77 | @class = $1
78 | @url = $3
79 | @caption = $7
80 | @link = $9
81 | elsif markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION
82 | @class = $1
83 | @url = $3
84 | @caption = $7
85 | elsif markup =~ IMAGE_URL_WITH_CAPTION
86 | @url = $1
87 | @caption = $5
88 | elsif markup =~ IMAGE_URL_WITH_CLASS
89 | @class = $1
90 | @url = $3
91 | elsif markup =~ IMAGE_URL
92 | @url = $1
93 | end
94 | end
95 | def render(context)
96 | if @class
97 | source = ""
98 | else
99 | source = ""
100 | end
101 | if @link
102 | source += ""
103 | end
104 | source += ""
105 | if @link
106 | source += ""
107 | end
108 | source += "#{@caption}" if @caption
109 | source += ""
110 | source
111 | end
112 | end
113 | end
114 | Liquid::Template.register_tag('image', Jekyll::ImageTag)
115 |
116 | is written as this Hugo shortcode:
117 |
118 |
119 |
120 | {{ with .Get "link"}}{{ end }}
121 |
122 | {{ if .Get "link"}}{{ end }}
123 | {{ if or (or (.Get "title") (.Get "caption")) (.Get "attr")}}
124 | {{ if isset .Params "title" }}
125 | {{ .Get "title" }}{{ end }}
126 | {{ if or (.Get "caption") (.Get "attr")}}