From 90449faa8b1cac9af8a8d2bdd679abe58078d332 Mon Sep 17 00:00:00 2001 From: Xananax Date: Sun, 3 Jul 2022 00:21:20 +0200 Subject: [PATCH] commented code, added some info, added icon --- favicon.ico | Bin 0 -> 15406 bytes favicon.svg | 69 +++++++ files.txt | 3 +- index.html | 400 +++++++++++++++++++++++++++-------------- readme.md | 16 +- tutorial-hackers.md | 4 +- tutorial-publishers.md | 16 +- tutorial-styling.md | 13 ++ 8 files changed, 375 insertions(+), 146 deletions(-) create mode 100644 favicon.ico create mode 100644 favicon.svg create mode 100644 tutorial-styling.md diff --git a/favicon.ico b/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..b918b1856aec9c5030b0a29848ece9ca8f6938d9 GIT binary patch literal 15406 zcmeHO2Y8fKy8d-l?BcqjVu4kzU`Qo^lwjxyY11;vOnL#`>#kj&RZt^#*Rqy%mDOED zsVOs)5JLJteS!;KRFo@<)D+St(`Wv6?t3P%au-ZkNO<;n?w#j3&p-M9`Oo>jbH4h1 zUl`^B<`>M^u?(&gncrN*Ff$p3nK*Iq?$?wXs2wMxbi_Z=I!ER zOScyIl&n0YX_+c1Y~u(+E*x%}uM##~>&$Na{edN0)*no(I_S+ab_vCf@A+)oUx<>O zLYVSj3^fN`BZ%Jx)y7YKIYw89yqfdo8wH`n(I;vxpGpe$mZ9FK&jyy(|B_dm-W76f z`@LB$z3p-X?<+70V!rK%psGbl64@(ZbI|7`t97ne?AQ}3u?ff2+oW#Qwh&irb%_PGHli{|54WErwf0(3 zZF){Dv3CUu&Ek*gl>~f9LaE)wXItJSY3#3tqygvdPidLJYpq-OV!O9ny<;Fdx(=u5xImFb5|_9232OEcl3aK7P&CkI&P4rK zA=C0$K-Kz(E=6sRH_jfpsP`$F{oM-;#IvZ5_b;sf zB9Ksf`*82m=Tds}4WaaA);+r>)Dv4l2I6#*JI-*}7gaUuOy2LA{P9)Z8P&gc#p#a? z#8gSHSRKLW^hQ>uoXPuyDZ4NjVTf?Y=$hTJx_)=8-h=BNUxbdDf;0M%32QI)Mpq`e zWAqy_8r_llXWVyg7*Yn#WMXP(CSuITp!R9FPZ@Z5iAlbGH6xo>#wapYG3td+Gm4lp zCXt$}^YOW$j7h$_jLC>t#mMG7$z+@e0ciSDXSlDjDGbG#%XV_ z+&SwnPaIrS`E++$ZJ9TleUj5!en$%IStQ@Gm{Xf(2GZF{(vsa*i~ubcP#X3w_-t}l z=GKSX6^1q6FWT_Iw~6c4f46vp?NGXIuP3MV8=<7_OR>c9xm4`f4%_v9NN!$1X&8a^ z!&6APrklv}w#+~tySg*g@X?Xvs-{C}x{jlYYN=1tAbIkQQmEJ}fd;3LZ{H1@_=%u4 zYl*z+&Yn4jtIm}UDbs!#$!q&{P-{#HD4JgLDw|o4wzacg+bFfmtHlmQjYw&L-3*DP zjsdaQ{;il}-6&+T4^SG;b^Wl7Os*RfQnbW~na1aNjm5;nclq*6{4vGWKzoKE(3jo7 zdka{?mD-3{+UABI`c~AK*AlgDp%mS4#c;lPI2tJpLAmiRUd65!G-fmQxt+_i_~C<{ zy^1>L(F}dCU0F>i4bqCX5Gk?`i1}7iNNp?$q&D47X&7#e;hvK;%WZNDU0FjqPz{MoI0LmHC>d$eBASf1il<}@k8I{xS8AMQTgJ4%C;Y`z};Hk#y^S4gD}J1K1w zh2;*(Ut}hTg$Uv)0r614rD<{p3oX5flMX^2cR?pU<^5n8&uex45DmO?S%B_;Gz$9UP0lLD$Hnou)OO9uD)i^58 zXS&YM{f_#Wkir%z<+j}?74L8$Cla|ro8Z>A2uITO;-T~^_$XEi%K>PRO4_~^wWjB| z)aH3oLLIWfbNht#GHvJOB!6duRNz=I6}0UW3mjkhG_8A&r0JaS(~>){RT5XU5%Jy~ z@DGk7ywy5T$Or|J59DP#~dKo|O8 zn|JV;?3*D)^R#p0{-?J+OB%-UGGhuSXMe{j*vH|g-|tn{{dc#jjyTng#H(RRDA!E* z9IF@d@?%imvYwN*%=u}CbNfbfOG*P#n(h(R##chwMpHm*>~gD{NN-9l>0MGoJj)tL zFtynqT-MYPNN%k3CpFJIw^dJlo2ZRZ@Vg&!ne6_MveoTPZ6MwE=tS2F`#e$QQK!yw_IC~-m-SE8 z-|CAsWFil)2Mx%F^`U=WANg{4|4EE~;@Piu>YL$s88kSfHcxZKRJ{T|O<4asj81&- z#^^+j{eve)SK&gAFHKo@-Kn#j+Z{@SG-=EAo|wu7o><*O;B}oRMsLKr4(tbu@9R8~ zx<@@zsv-$9a=GitRFj)(E)PuA-QkU?N`*YU>WS0oajo~n>Z?4_hFASj)mr~uwG&Q$ z=l|+=ijx4MWr{G)1Si4Im@>q}?=Z<@USv{lUd^PK_wM^lq zb(0<#vnQhLk}!@Mzw=@e9*D;i*^9z>BHh08_qm`PSPjLdK>tLFQ$54T<3W3PJkR9B zzj1M4{GYE`9{ti1}dRH?u1z_?Mb)r5L4@WV%TLp5%;S$4axd zTt;J=^Tz^n!2`^sF@u=bl5wk;rMEuGq)&R9QAfRcQGUW7uUe7u=j-mzUwgwNn$5Sa zOs~1~wM9GPKECH*Lgidva^oy6%{U{JVvP+YwM-2pZJ#&*JS?0a4TJrT0)H1GpudRX zW)Ct8Z-5-#`Q{b(F8KI{2TIo7^4PPRCOo-H{~ymi&=~n<@vgf+$~!o}Jhy*YeU3l9 zG0T_HtOzO*w<*nYX-*|&Hs2i1?_}&)qGqoQ2JMip7HkU_UZ3E|MwXmtom~9+ULGsy!n;G%XEM2k!^d+oz?n>P_Ff5F37vgObF z7Oj8pn|s#2_f6uub^pC+L+$?LEw*-9O`B8G2Y3RQBWR+tBZ`JOzoq1m&P(RRA|i&6`5agW;cA$o~Hln{zV%$?pw5>dEb&vdw*EA z#d$<-@bzmNeZU@kz(Bl0sl$yNuU{;*?-O!tW?pSs&nZn$@^aL5QrH{A`VCt(lC+*~ zuCP7K-+3GMb3R$oR^r#TuIiI*d#7WWeoIG+!3@mq$96?cfYxlfv+96jHimN~f1z0t zO6)vx$UdRa@jWmuTNuyGwmgoUeHq1FyeYLe()mxf?nvDW=W|s53U=PX71`$awWeI3 zqG7dLR=>%mYO=brnhp$TngTsp^-`CrR-`y+x4KR|p63a`AbpUhKAgoNvCv`TbAb_9bf7q_&zw+X3ra=yUeu{uffqgxEFHQWwy8G`*71j~)&87}pUM4jj3zhV$;*vO z;OEZ(|62n**Z?dNc&K#`ueBWHa?CxR>}GdwW?cYwN$6130K)@rqHPjAxvimKp2-8+ zJAj{>@&0=OIlCetZ&?~jWg}sWekI+48VR#=#AlBsC!*HYAm-ZkKsNdUx#j@s&mrKABE=sm_6T0Y9#x&!o7LRSX-xZR?E-cF&w$IX z4k_4TKEt>mklb4FVH-Jp07K>d_CoXq*~(nR8x{5V~a$s^$o;2EHHj2twZpzn?cm#TzM_w z{XdvqB_4%N^eDFVxwD#%`Zer#oYuSx`p-fSwqU$1z_-CqD@aCL1b8^>`pC&L^UvSu zzJz5o5q3MR>9$a6OAJ9w0C|3jl-TP~$LNR8g3WhGusM*tBO!ws{drZX32|;-6_d)4%CCP+g#QTUy*Wo~RpQ zNxpT3RAS!@8%b**K@1K&h=?P?xI2w6P?MqFJS$0)RF#+EZ^Z0Q8U9ih?Gtz=%w|f zy-6Dgt!wpa>QT?JN>o>b6^_BWcd;G5+1|pd%^z|K(_{p){tDgg2t$)TX!Vyov=y0=oRBs z)_Kr{RYI1v4*hw1C_T`H5bY^LT^4!HV2>KLM|6OPa9s>Jn}`}R2Yv&v16`;USHV9N zNec9R&|2>($9Hr;!ZA{Ybu#o%jr!G#@W~ZY5&Bw6+r03}k}uyRy0pzA;%l1gNQW|X z;eI=JZYz5B93rhPQXVAqpdkNm#2G$8RESX*8^)vNKI$`ngj%4Vm zZ3_Eq)HP{+liE~2dMdw!Kl=nZ(?dbj$5Cs$liIqGl>5`og?#NolDuz>l=;Q=ByUGD z$#=Ylo&yVNvb!KpcGSnsE_KuHj*Ob42U046bpH`wOXwMZ9X(!~Mehvs;0MrO7s@og zg?zb~%V?ZV`+ZNh=1ATf)Mav^l!2To%Q8#QSRWBJmQQ(&bpxMm{xFnfdS^gcUjh2R zL`~b<0Uf6FQ(r*+9p!=C3mqtSv?C^>`Emv7fKTx+iJ(&yMbGT=|?;yLB|PVSAt$-0k*ea$hG{yXQ6jS zZF++THc8`^q1GJ9XM_1p<9O;r(etI|E*Z&ygh{)x|M$sp>T=aGKo3-J9u8lx)MNaR{FDhH^! ze;QP?CeXPbxn^JhwD+agk)GtOq<b~scGd$tfXgrU7Oysi7&k9+lM##ioSqLAqyElKwdc;!da)y$Q8J)UVy%xwS`pb89zyXW@SZCL6{RX6>ltW<%`* z>HwGX3e!S9)AS~K55M9vTDk*CjUI1eoiH%BhV;%vJU6YJbWf`w{nK#Ij=HA`5L6ZWg%#P6aI+GbB}+1oyR@1MsQ9;UqWmp z>4`2Uy%_y5=+8j!I{MJ*5K%jKqjp^HiLQDu7*QS}P5JDmq4sJtp3z*8OKO^po|ToM z)aLDw>2G{T2_ zTBGrd_67{l8veBEG;e(M?>*D>>(I-wlgb8Y712*34a7ob2LES){@=n+`yZq8L3WG- zk(JMSrdG`NMsGalp1*&UN9xPEA-BFb!*tIyT^4#SUV=Fy{9nXV?wHMU-Ld5n|LXeZ`ulJn$7I7*{dZMP@I_bL?Tgjlk3Nzu;NdW?-s3!o zr=uUwApcci`42@^O(W6Ozdl!b&gT7{kRj;7mHw%lZUsFG$j-ayf!U4G4j%fzix0F0 zkMk13^T6Oe{V`l?JW&^KFL3|Vh(gT594{r{zk}5E%v+-^f#loslpp=c+VSM{S@7M&t!d6`%P;ur!m#( z<~?8cDE-oPhO7J$HMdcHq_lZsbWfuv>QnT}89Z@@I_N_K_}B#6-||FPKjw?n%iZ|j Su5; + + + + + + + + + + + + + diff --git a/files.txt b/files.txt index 632cf34..1a8112b 100644 --- a/files.txt +++ b/files.txt @@ -1,2 +1,3 @@ readme.md 2022-28-06 Tickle -examples.md 2022-28-06 Examples \ No newline at end of file +examples.md 2022-28-06 Examples +tutorial-styling.md 2022-28-06 Styling \ No newline at end of file diff --git a/index.html b/index.html index d20fd89..cd2d05d 100644 --- a/index.html +++ b/index.html @@ -22,15 +22,89 @@ margin: 0; padding: 0; } - .trigger { - display: none; + body { + padding: 3em; + max-width: 52em; + margin: 0 auto; } - .left-nav > * { + pre { + margin: 0; + padding: 3em; + max-width: inherit; + max-height: 100vh; + overflow: scroll; + background: rgb(192, 192, 192); + position: absolute; + top: 0; + left: 50%; + transition: all 1s cubic-bezier(0.68, -0.55, 0.265, 1.55); + transform: translate(-50%, -100%); + } + .is-source-enabled pre { + transform: translate(-50%, 0); + } + button { + display: inline-block; + border: none; + margin: 0; + text-decoration: none; + font-family: inherit; + font-size: 1rem; + display: flex; + justify-content: center; + align-content: center; + text-align: center; + vertical-align: middle; + background: var(--accent); + color: var(--background); + cursor: pointer; + padding: 0.5em 1em; + border-radius: 0 0 0.2em 0; + box-shadow: rgba(149, 157, 165, 0.2) 0px 8px 24px; + -webkit-appearance: none; + -moz-appearance: none; + } + h1, + h2, + h3, + h4 { + color: var(--accent); + font-family: "Lobster", serif; + } + a { + color: var(--accent); + position: relative; + text-decoration: none; + padding: 0.1em; + } + a::after { + content: ""; + position: absolute; + background-color: var(--accent); + position: absolute; + left: 0; + bottom: 3px; + width: 100%; + height: 1px; + z-index: -1; + transition: all 0.1s ease-in; + } + a:hover { + color: var(--background); + transition: all 0.3s ease-in-out; + } + a:hover::after { + bottom: 0; + height: 100%; + transition: all 0.3s ease-in-out; + } + .menu, + .burger { position: fixed; top: 0; left: 0; } - .left-nav > .menu { + .menu { padding: 1em; transform: translateX(-100%); display: flex; @@ -40,39 +114,26 @@ transition: all 0.3s ease-out; gap: 1em; } - .left-nav > .menu a { + .menu a { text-decoration: none; background: var(--background); color: var(--accent); box-shadow: rgba(100, 100, 111, 0.2) 0px 7px 29px 0px; padding: 0.2em 0.4em; } - .left-nav > .menu a:hover { + .menu a:hover { background: var(--accent); color: var(--background); } - .left-nav > .trigger:checked ~ .menu { + .menu-is-open .menu { transform: translateX(0); transition-duration: 0.1s; } - .burger { - width: 2em; - height: 2em; - display: flex; - justify-content: center; - align-content: center; - text-align: center; - vertical-align: middle; - line-height: 2em; - border-radius: 0.2em; - box-shadow: rgba(149, 157, 165, 0.2) 0px 8px 24px; - transition: background 0.5s ease; - } - .left-nav > .trigger:checked ~ .burger { + .menu-is-open .burger { color: transparent; } - .left-nav > .trigger:checked ~ .burger, + .menu-is-open .burger, #Loading { top: 0; right: 0; @@ -80,9 +141,10 @@ height: 100%; border-radius: 0; background: rgba(17, 17, 17, 0.2); + cursor: default; } #Loading { - position: absolute; + position: fixed; text-align: center; align-items: center; justify-content: center; @@ -94,16 +156,15 @@ display: flex; overflow: hidden; } + #Loading > * { + animation: load 1.2s infinite cubic-bezier(0.215, 0.61, 0.355, 1); + } .is-loading #Loading { opacity: 1; height: 100%; transition: opacity 1s ease-in, height 0 linear; } - #Loading::after { - content: "❤"; - animation: beat 1.2s infinite cubic-bezier(0.215, 0.61, 0.355, 1); - } - @keyframes beat { + @keyframes load { 0% { transform: scale(0.95); } @@ -123,48 +184,37 @@ transform: scale(0.9); } } - #Body { - padding: 3em; - max-width: 52em; - margin: 0 auto; - } - #Body h1, - #Body h2, - #Body h3, - #Body h4 { - color: var(--accent); - font-family: "Lobster", serif; - } - #Body a { - color: var(--background); - background-color: var(--accent); - text-decoration: none; - padding: 0.1em 0.4em; - } -
-
+ 

+    

+      
❤

+    

     
   
 
diff --git a/readme.md b/readme.md
index 5b8d302..8554057 100644
--- a/readme.md
+++ b/readme.md
@@ -15,7 +15,7 @@ By default, Tickle will:
 
 1. Read a text file containing a list of posts
 2. Load the first post
-3. Parse the markdown
+3. Render the markdown
 4. Display the list of links, and the pages
 
 Tickle is small enough that a moderately knowledgeable programmer should be able to make it do whatever they want.
@@ -24,10 +24,10 @@ Tickle is small enough that a moderately knowledgeable programmer should be able
 ## How do I use Tickle?
 
 1. write markdown files
-2. reference your files in a text file called "files.txt"
+2. Optional: reference files in a text file called "files.txt" to fill the side navigation
 3. upload everything on some server
 
-We have a [neat little UI to help you do all of that](https://git.poto.cafe/yagich/ticle-godot-frontend). You don't have to use it, but it's neat.
+We have a [neat little UI to help you do all of that](https://git.poto.cafe/yagich/tickle-godot-frontend). You don't have to use it, but it's neat.
 
 Here are more detailed explanations, for different knowledge levels.
 
@@ -45,7 +45,9 @@ It's important to know that Tickle is an *idea*. Think of it as a specification.
 
 ### Q: What if I want custom functionality, but don't know programming at all?
 
-**A**: Check the [examples](examples.md) first, and see if there's something for you. Otherwise, write to us! Find us on X or Y, and shoot your request. Maybe we'll get to it
+**A**: Check the [examples](examples.md) first, and see if there's something for you. Otherwise, write to us! Find us on X or Y, and shoot your request. Maybe we'll get to it. 
+
+TODO: specify where to find us
 
 ### Q: Everything in the browser? Isn't that bad for SEO?
 
@@ -53,7 +55,7 @@ It's important to know that Tickle is an *idea*. Think of it as a specification.
 
 ### Q: Isn't it bad for performance?
 
-**A**: Again, who cares? For Facebook, a microsecond lost means a large amount of people will not see ads fast enough, that loses them money. But someone who comes to read your blog will wait 300ms to read your article, no worries.
+**A**: Again, who cares? For Facebook, a microsecond could mean a large amount of people will miss some ads, and that costs them profits. But someone who comes to read your blog will wait 300ms to read your article, no worries.
 
 ### Q: What about accessibility?
 
@@ -61,7 +63,9 @@ It's important to know that Tickle is an *idea*. Think of it as a specification.
 
 ### Q: What's the license?
 
-**A**: The license is [[upcoming]]
+**A**: The license is upcoming
+
+TODO: decide on a license
 
 ### Q: "Tickle"?
 
diff --git a/tutorial-hackers.md b/tutorial-hackers.md
index fc34771..41eaad8 100644
--- a/tutorial-hackers.md
+++ b/tutorial-hackers.md
@@ -6,4 +6,6 @@ Tickle consists of 3 distinct and simple parts:
 2. parses markdown files in the browser
 3. displays the markdown files
 
-To parse markdown files, the default implementation uses Micromark, but feel free to plug any parser you like.
\ No newline at end of file
+To parse markdown files, the default implementation uses Micromark, but feel free to plug any parser you like.
+
+The source is commented fairly well, and your best bet is to check out the [examples](examples.md).
\ No newline at end of file
diff --git a/tutorial-publishers.md b/tutorial-publishers.md
index 17e50c1..803522f 100644
--- a/tutorial-publishers.md
+++ b/tutorial-publishers.md
@@ -5,20 +5,24 @@ Unfortunately, we couldn't remove entirely all the technicalities. But we've man
 There are 4 steps to writing articles in Tickle:
 
 1. Write the articles in Markdown
-2. List the articles in a file
+2. Optionally, list the articles in a file
 3. Optionally, preview the site locally before uploading
 4. Upload everything on a server
 
-We have a desktop app that takes care of steps 1, 2, and 3 (and maybe some day step 4!). It's comfy, made with love, and you can install it from https://git.poto.cafe/yagich/ticle-godot-frontend
+We have a desktop app that takes care of steps 1, 2, and 3 (and maybe some day step 4!). It's comfy, made with love, and you can install it from https://git.poto.cafe/yagich/tickle-godot-frontend
 
-But if you want to do the things manually, read on. You need to do step 4 manually either way.
+But if you want to do the things manually, read on (You need to do step 4 manually either way).
 
 ## 1. Write A Few Articles
 
-You will need some knowledge of Markdown. This is how we write the articles. It's really not hard! In fact, it looks very similar to how you already use characters in chat for emphasis. Check [a reference here](https://commonmark.org/help/). Create a document, call it "my-first-article.md" for example (`.md` stands for "markdown"). Write some text in it.
+You will need some knowledge of Markdown. This is how we write the articles. It's really not hard! In fact, it looks very similar to how you already use characters in chat for emphasis. Check [a reference here](https://commonmark.org/help/). 
+
+For example: create a document, call it "my-first-article.md" for example (`.md` stands for "markdown"). Write some text in it. Want an example of markdown? Press `?` on any Tickle page in any Tickle site to display the source.
 
 ## 2. Create the List of Files
 
+This is optional, and is used to fill the side navigation. Without this step though, your site will be empty, so you need to write at least one page in it.
+
 Once you have written a document, you then open a new file, call it "files.txt". At the top, write:
 
 ```
@@ -31,9 +35,7 @@ At this state, the site is "ready". You can upload it, but before that, you prob
 
 ## 3. Preview the site
 
-You will need to run a server. The easier server to run is [our own](https://git.poto.cafe/yagich/ticle-godot-frontend), but if you want other options, you want to search for "easy http server", and see what you get.
-
-- TODO: list a few good options here
+You will need to run a server. The easier server to run is [our own](https://git.poto.cafe/yagich/ticle-godot-frontend), but if you want other options, [XAMPP](https://www.apachefriends.org/download.html) is a good one (but is not specialized for Tickle).
 
 Once you have the server up and running, you can open a browser to the address the site opened. Usually, something like http://localhost:3000. The number is arbitrary and might be anything; it depends on the server.
 
diff --git a/tutorial-styling.md b/tutorial-styling.md
new file mode 100644
index 0000000..cfae5f0
--- /dev/null
+++ b/tutorial-styling.md
@@ -0,0 +1,13 @@
+# Styling Tickle
+
+Tickle's CSS is kept very simple on purpose. It matches elements, rather than classes, because that's less clutter.
+
+If you just want to change the color scheme and fonts, you have css variables in the `:root` selector, which you can use for that.
+
+If you want to add more styles, or edit styles, be aware that:
+
+1. Modalities of the page are handled through toggling classes on the `body` element. Those modalities are:
+   1. `is-loading`: for when the loading overlay is shown
+   2. `menu-is-open`: for when the menu and overlay are open
+   3. `is-source-enabled`: for when the markdown source is shown
+2. The navigation burger button *becomes* the open menu overlay. That saves an element and is neat, but it means that if you have transitions on your button, you'll get strange flashes as the button stretches and cover the entire page.
\ No newline at end of file