From f75dd94998e7a5091a065584191ac8173725b738 Mon Sep 17 00:00:00 2001 From: George Cushen Date: Sun, 5 Jun 2016 01:08:18 +0100 Subject: [PATCH] Update docs --- README.md | 2 +- exampleSite/content/post/getting-started.md | 3 ++- exampleSite/content/post/managing-content.md | 12 +++++++++++- .../content/post/writing-markdown-latex.md | 9 +++++++-- .../static/img/banners/getting-started.png | Bin 0 -> 4529 bytes 5 files changed, 21 insertions(+), 5 deletions(-) create mode 100644 exampleSite/static/img/banners/getting-started.png diff --git a/README.md b/README.md index 122082bb..3c8575ca 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Latest demo: [gcushen.github.io/hugo-academic-demo/](http://gcushen.github.io/hu 2. Install Academic theme with [git](https://help.github.com/articles/set-up-git/): - git clone git@github.com:gcushen/hugo-academic.git themes/academic + git clone https://github.com/gcushen/hugo-academic.git themes/academic Or alternatively, [download Academic](https://github.com/gcushen/hugo-academic/archive/master.zip) and extract it into a `themes/academic` folder within your Hugo website. diff --git a/exampleSite/content/post/getting-started.md b/exampleSite/content/post/getting-started.md index d86ee82f..05e60d26 100644 --- a/exampleSite/content/post/getting-started.md +++ b/exampleSite/content/post/getting-started.md @@ -1,6 +1,7 @@ +++ date = "2016-04-20T12:00:00" draft = false +image = "banners/getting-started.png" tags = ["academic", "hugo"] title = "Getting started with the Academic theme for Hugo" math = true @@ -28,7 +29,7 @@ Key features: 2. Install Academic theme with [git](https://help.github.com/articles/set-up-git/): - git clone git@github.com:gcushen/hugo-academic.git themes/academic + git clone https://github.com/gcushen/hugo-academic.git themes/academic Or alternatively, [download Academic](https://github.com/gcushen/hugo-academic/archive/master.zip) and extract it into a `themes/academic` folder within your Hugo website. diff --git a/exampleSite/content/post/managing-content.md b/exampleSite/content/post/managing-content.md index 8ecd63f7..e0e8b900 100644 --- a/exampleSite/content/post/managing-content.md +++ b/exampleSite/content/post/managing-content.md @@ -99,4 +99,14 @@ Then edit the newly created file `content/project/my-project-name.md`. Either yo Generally, to remove content, simply delete the relevant file from your `content/post`, `content/publication`, `content/project`, or `content/home` folder. -Then you can re-build and view the updated website with the `hugo` and `hugo server --watch` commands, respectively. \ No newline at end of file +## View your updated site + +After you have made changes to your site, you can view it by running the `hugo server --watch` command and then opening [localhost:1313](http://localhost:1313) in your web browser. + +## Deploy your site + +Finally, you can build the static website to a `public/` folder ready for deployment using the `hugo` command. + +You may then deploy your site by copying the `public/` directory (by FTP, SFTP, WebDAV, Rsync, git push, etc.) to your production web server. + +Note that running `hugo` does not remove any previously generated files before building. Therefore, it's best practice to delete your `public/` directory prior to running `hugo` to ensure no old or interim files are deployed to your server. diff --git a/exampleSite/content/post/writing-markdown-latex.md b/exampleSite/content/post/writing-markdown-latex.md index be2ea884..7cd6aed4 100644 --- a/exampleSite/content/post/writing-markdown-latex.md +++ b/exampleSite/content/post/writing-markdown-latex.md @@ -6,7 +6,7 @@ title = "Writing content with Markdown, LaTeX, and Shortcodes" math = true +++ -Content can be written using [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet), [Hugo Shortcodes](http://gohugo.io/extras/shortcodes/), and [LaTeX math](https://en.wikibooks.org/wiki/LaTeX/Mathematics). Additionally, HTML may be used for advanced formatting. +Content can be written using [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet), [LaTeX math](https://en.wikibooks.org/wiki/LaTeX/Mathematics), and [Hugo Shortcodes](http://gohugo.io/extras/shortcodes/). Additionally, HTML may be used for advanced formatting. ## Sub-headings @@ -103,13 +103,18 @@ To include a single tweet, pass the tweet’s ID from the tweet's URL as paramet ## $\rm \LaTeX$ math - ```TeX $$\left [ – \frac{\hbar^2}{2 m} \frac{\partial^2}{\partial x^2} + V \right ] \Psi = i \hbar \frac{\partial}{\partial t} \Psi$$ ``` $$\left [ – \frac{\hbar^2}{2 m} \frac{\partial^2}{\partial x^2} + V \right ] \Psi = i \hbar \frac{\partial}{\partial t} \Psi$$ +Alternatively, inline math can be written by wrapping the formula with only a single `$`: + + This is inline: $\mathbf{y} = \mathbf{X}\boldsymbol\beta + \boldsymbol\varepsilon$ + +This is inline: $\mathbf{y} = \mathbf{X}\boldsymbol\beta + \boldsymbol\varepsilon$ + ## Table Code: diff --git a/exampleSite/static/img/banners/getting-started.png b/exampleSite/static/img/banners/getting-started.png new file mode 100644 index 0000000000000000000000000000000000000000..47d46169f054dd29b6cdc46a1446fbd1506d801c GIT binary patch literal 4529 zcmcgwXIN9&*4_zG6e)^2bd1qaDJF!T2m}l$D7{NF5F#~&5PFM@BUe$dAxe|M0UQtz zqz46M=p*PLMLIYb2myiu(j;GS#<|~*JNM^3&w0)+&wAhWuD#dV=Q-z!wdH9s5m^xc zfS8%7u`K{FK^LOBLrBp0r=VR0jSR!YnPEr0zzFlClYo&o)r$l-BYXOgY)PKp5kYMv zJphCde)i4`XA5&IkxE8-ZrLEi$ut2P06knd&65~FV!*vfK7JH^#5}7W0r&IPM>uI& zs9DhPBws(%NIJB%BX9P66fJ|a|!o$gdlwfSQKH@7cR?y#?Mj_x| zO&9_Ch(AR+TUf*KR5}T+h157sR70cT+S*98rk1ugS{1IYhE_+Z32yDu1rFlbm5Dl9Av8K!}x(tS{93lZHYg)wV+V zW@usY-%ZKnzpaBAwxoaS{g1@K_7OA^%9a#N4WSbS8+YN*mMa<-PbYaYsC0WOHSpUi zTKiHN)L>sK4UV_dh97hCqj*!pf|b77TUcPtD8UR*3Xx=Htd9^dApQKjv8Rl+jMOxZ zPO9q|30B=iTh|1yg)ze8Pidl!Of)e@->}A1VhEW;VSK}S{~L?{N9xK|st8k}uf)30Zk6H|QDeIkEI)KhuX5~cV%5l}&)BF!Xhp6DN|_2CXw_Y% zy8+jPg(i{}=QowdK7eDL+<*(@{h4T+2RTAYP-cDpXhu;la?{L?Uj+J#`~tGetEXU^ zP-e`sdmnpE^z$sV&I2&gyG+S{$QS}%)!WqMd<(**d38t?-&YIvIE0@mkMdD5{`#{0?r}Z*?u}xomsJOsI0pdy}Hv7@}8*$9|%n zSbc{L;0{hMrl6OU!YZy;4rhE+a`lkP{-m;I-TYyC{-l4CDX#`}r@jagW~X$lR%bp+aNp9nlFxGkI@ifpM(;UhmU?Y0#Rxd? zOqn0n-2-=Lix*wOeHV8S)b==p&tx(qb8{a&-wzT9xD9hl@YbPOQOt>?>DEgf&^hAB ze%H1%v+KaNhGKUQB{}^%&TkW5{_DTyqHvPnVv$%{#TWB|BTpu#=VGac_p7)3#v<%EyH;?o0mhEO=!EgoZKh+xK}Fb2c|E z<}k=Rf&=OW!Rshx2u~9asw{a$$W;^4sRv_=zUC{=14Tsb34tsI(UBqnYbb8xVH)?4bb^3q^PLIX9n@_{hpr&<~tL@L>0|~ zS|ykn9P`axkSAwJ<#Ewxuhy|!TTV{UMOB&n4uK{!YVG^XfThZJ4=Q6NeLtz(UiJ^f zlWZo14IM+8g#oN#By+CxB|B%D&wmf;-Yp|tA993n3dkoUr;?rAHxRn8wJdSG)4t)? zLvLw~nOFQZwjuJP-?0p0E%=2}-SO?^YUXJ>@14)=;L71He3$YJ^w)F5?OvjqhZ3;7 z7YjZ@gpHWC9@5G}h|2>d`_wAUq3i51j(uentU+FR7{fTdc>(<4#Gc6Q;6-JSCc}=n z1)-!t3{T%xrp`xC7o;Kk4O$4o*@>e5qrAiA7gY0yz>bmw$AtQbrOSsu23gIuW5(q^ z6@HTD%85b=?4;3>Ol@^t`yVe$ACLoyeLT{bhs?Q=a&zWJu{AGcm=nFmQ*wIIS8nG| z^}VP599@rPw>}(!gJp7I=*zGQFS4}fwI3T7i4f~%Ec@cFP;^|}^W5P+zI_<9-m~khh~nO z#FjN5I}Qfw5|TDJfnJ4eA`spLM9qX^llp9aAs?E3P5d=~waX&#J4TRQV^K%BR3eF^ z^q}NG+M&Bu$etJLOY2w|L0;@fkX7;UKD50y;Lx>{W5b@=~Rh5e@uA)HV2sd7zTi)^X#1iK0 zN*R=(++N6!nhIq923kuxW8X(KdS&;CGnFG`eLp5KaQi?{v+5L8XDC^0Niy~A_uCEK z@8IjTS}IMYp`x+G*bqw7D>K0De}eWXR{$1~i89M_z_qG)@T_hIG{ggxlX?zYlv%kl z53DqEIghKvpX~!D94UGzim+ki514tM`GX+s`rQ*FCF7No(s6sAgzT@t->z%_;0n3n zo|!&+0e?e(CTG6u{0Ts(xR0WyYh6QOx6UUPTNFrvp~iBwk1-f39Y^NvRIn3*le(dh z28&y;cnqB6^Jh4Ua91BuYcJ&Fo3jMsw&x*)m;~`y&`&-)PAh$djm^gAx0(DcVP% z`c!aDuH~NAUEA-o!rOm+gebeQvIlbGeCBBl$oVOm?EAJYyLzG7Q3XJ^iDeM%*jOaF zZc_uHjZC|6gMT-`f?Dng(~1QXC?Nsqb8qn%o14|rzAb_jf8ddjE(F)(YwJ>x;q5o? zFMm1&h1X*{R?-U20j`_O{hZjKMn8(PcpV!Y6EAH7KanrloT}0O@@gc9#V68m*>LqkICW^ zqRdIE%Vr$YJs98kY+!rfy)F%c2Xacm*0M(2ⅅRWM~FagPoW)>%qXb-`r4t-EF!V z(pLeTxhL22d#Z@E=wn##P}2Z)>i*X(l! zJJ}>M(PjP%d;EFg#g|qJW<3#0>rJt8yy+3x;+51d)mjmMJY8cYXEi>lPD0?0zH@Tu zIT{l_3QR}A%%)Ogj7CiJXA= zR_jVkoXZ{j(wn>yIs11NR*d$^5~F(J5`Q(8YWI3N%q;q_?~=#0ro|#>WJ}lXsTK-$ zJxN1CiOc0=bZ|7*3&uYO^|FPh2PXXN=iK0ezYZHeB+aPYzZhqzFf1b!PG>)~>pR47 z_kO4{Hmx9j({i(E-;kx}i^6Fl>sAKzEScFyLz5?^&z0yYtAt~MX;%il$mOdlJWdx# zXq=bnn)OPm69;uUUL>h5j{l?u5e7VL+c{tI94vWh+xu`+LNEn)KJVqgRAu(jEu1K;QWPXVCDW*-bNImKo+UT&^YvqW_73MF7lr>fpHW+0nABA(CIle0!^XOg R27TI^GBdF>E