auto-commit: Sunday, 2023-05-28 04:07:23 PM [on 🌸]
This commit is contained in:
parent
16d8751590
commit
cf5c98ade5
GPG Key ID:
924A5F6AF051E87C
3
.gitmodules
vendored
3
.gitmodules
vendored
@ -1,3 +1,6 @@
|
|||||||
[submodule "themes/hugo-book"]
|
[submodule "themes/hugo-book"]
|
||||||
path = themes/hugo-book
|
path = themes/hugo-book
|
||||||
url = https://github.com/alex-shpak/hugo-book
|
url = https://github.com/alex-shpak/hugo-book
|
||||||
|
[submodule "content"]
|
||||||
|
path = content
|
||||||
|
url = git@git.tablet.sh:the-btfash-foundation/site--tablet.sh.git
|
||||||
|
|||||||
1
content
Submodule
1
content
Submodule
@ -0,0 +1 @@
|
|||||||
|
Subproject commit 172b7a2c03a72072cc19b992ed8cf5451af2dda5
|
||||||
1
content.old/.gitignore
vendored
Normal file
1
content.old/.gitignore
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
cs61b
|
||||||
33
content.old/_index.md
Normal file
33
content.old/_index.md
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
---
|
||||||
|
title: 💜 Welcome to Amethyst!
|
||||||
|
enableToc: false
|
||||||
|
---
|
||||||
|
|
||||||
|
## What is Amethyst?
|
||||||
|
Amethyst is a free [Obsidian Publish](https://obsidian.md/publish) alternative that is derived from two existing projects, [Quartz](https://quartz.jzhao.xyz/) and [Hugo Book](https://github.com/alex-shpak/hugo-book).
|
||||||
|
|
||||||
|
The purpose of Amethyst is to provide a space to publish more structured notes created in Obsidian that may not fit in the [digital garden](https://joelhooks.com/digital-garden/) archetype that is well-supported by existing projects.
|
||||||
|
|
||||||
|
Amethyst was primarily created as a theme for my [course notes](https://notes.bencuan.me).
|
||||||
|
|
||||||
|
## Get Started
|
||||||
|
> 📚 Step 1: [Setup your own Amethyst instance](setup/setup.md)
|
||||||
|
|
||||||
|
> ✏️ Step 2: [Editing Notes in Amethyst](setup/editing.md)
|
||||||
|
|
||||||
|
> 🔗 Step 3: [How to setup your Obsidian Vault to work with Amethyst](setup/obsidian.md)
|
||||||
|
|
||||||
|
> 👀 Step 4: [Preview Changes](setup/preview%20changes.md)
|
||||||
|
|
||||||
|
> 🌍 Step 5: [Hosting Amethyst online!](setup/hosting.md)
|
||||||
|
|
||||||
|
> 🎨 Step 6: [Customizing Amethyst](setup/config.md)
|
||||||
|
|
||||||
|
Returning user? Here's how to [[setup/updating|update]] your existing Amethyst instance.
|
||||||
|
|
||||||
|
Here's a list of all [setup-related notes](/tags/setup), which are also accessible via the sidebar menu under the "Getting Started" section.
|
||||||
|
|
||||||
|
### Troubleshooting
|
||||||
|
- 🚧 [Troubleshooting and FAQ](setup/troubleshooting.md)
|
||||||
|
- 🐛 [Submit an Issue](https://github.com/64bitpandas/amethyst/issues)
|
||||||
|
- 👀 [Contact me](https://bencuan.me/contact)
|
||||||
71
content.old/example/_index.md
Normal file
71
content.old/example/_index.md
Normal file
@ -0,0 +1,71 @@
|
|||||||
|
---
|
||||||
|
weight: 1
|
||||||
|
bookCollapseSection: true
|
||||||
|
title: "Example Site"
|
||||||
|
---
|
||||||
|
|
||||||
|
# Introduction
|
||||||
|
|
||||||
|
## Ferre hinnitibus erat accipitrem dixi Troiae tollens
|
||||||
|
|
||||||
|
Lorem markdownum, a quoque nutu est *quodcumque mandasset* veluti. Passim
|
||||||
|
inportuna totidemque nympha fert; repetens pendent, poenarum guttura sed vacet
|
||||||
|
non, mortali undas. Omnis pharetramque gramen portentificisque membris servatum
|
||||||
|
novabis fallit de nubibus atque silvas mihi. **Dixit repetitaque Quid**; verrit
|
||||||
|
longa; sententia [mandat](http://pastor-ad.io/questussilvas) quascumque nescio
|
||||||
|
solebat [litore](http://lacrimas-ab.net/); noctes. *Hostem haerentem* circuit
|
||||||
|
[plenaque tamen](http://www.sine.io/in).
|
||||||
|
|
||||||
|
- Pedum ne indigenae finire invergens carpebat
|
||||||
|
- Velit posses summoque
|
||||||
|
- De fumos illa foret
|
||||||
|
|
||||||
|
## Est simul fameque tauri qua ad
|
||||||
|
|
||||||
|
Locum nullus nisi vomentes. Ab Persea sermone vela, miratur aratro; eandem
|
||||||
|
Argolicas gener.
|
||||||
|
|
||||||
|
## Me sol
|
||||||
|
|
||||||
|
Nec dis certa fuit socer, Nonacria **dies** manet tacitaque sibi? Sucis est
|
||||||
|
iactata Castrumque iudex, et iactato quoque terraeque es tandem et maternos
|
||||||
|
vittis. Lumina litus bene poenamque animos callem ne tuas in leones illam dea
|
||||||
|
cadunt genus, et pleno nunc in quod. Anumque crescentesque sanguinis
|
||||||
|
[progenies](http://www.late.net/alimentavirides) nuribus rustica tinguet. Pater
|
||||||
|
omnes liquido creditis noctem.
|
||||||
|
|
||||||
|
if (mirrored(icmp_dvd_pim, 3, smbMirroredHard) != lion(clickImportQueue,
|
||||||
|
viralItunesBalancing, bankruptcy_file_pptp)) {
|
||||||
|
file += ip_cybercrime_suffix;
|
||||||
|
}
|
||||||
|
if (runtimeSmartRom == netMarketingWord) {
|
||||||
|
virusBalancingWin *= scriptPromptBespoke + raster(post_drive,
|
||||||
|
windowsSli);
|
||||||
|
cd = address_hertz_trojan;
|
||||||
|
soap_ccd.pcbServerGigahertz(asp_hardware_isa, offlinePeopleware, nui);
|
||||||
|
} else {
|
||||||
|
megabyte.api = modem_flowchart - web + syntaxHalftoneAddress;
|
||||||
|
}
|
||||||
|
if (3 < mebibyteNetworkAnimated) {
|
||||||
|
pharming_regular_error *= jsp_ribbon + algorithm * recycleMediaKindle(
|
||||||
|
dvrSyntax, cdma);
|
||||||
|
adf_sla *= hoverCropDrive;
|
||||||
|
templateNtfs = -1 - vertical;
|
||||||
|
} else {
|
||||||
|
expressionCompressionVariable.bootMulti = white_eup_javascript(
|
||||||
|
table_suffix);
|
||||||
|
guidPpiPram.tracerouteLinux += rtfTerabyteQuicktime(1,
|
||||||
|
managementRosetta(webcamActivex), 740874);
|
||||||
|
}
|
||||||
|
var virusTweetSsl = nullGigo;
|
||||||
|
|
||||||
|
## Trepident sitimque
|
||||||
|
|
||||||
|
Sentiet et ferali errorem fessam, coercet superbus, Ascaniumque in pennis
|
||||||
|
mediis; dolor? Vidit imi **Aeacon** perfida propositos adde, tua Somni Fluctibus
|
||||||
|
errante lustrat non.
|
||||||
|
|
||||||
|
Tamen inde, vos videt e flammis Scythica parantem rupisque pectora umbras. Haec
|
||||||
|
ficta canistris repercusso simul ego aris Dixit! Esse Fama trepidare hunc
|
||||||
|
crescendo vigor ululasse vertice *exspatiantur* celer tepidique petita aversata
|
||||||
|
oculis iussa est me ferro.
|
||||||
12
content.old/example/collapsed/3rd-level/4th-level.md
Normal file
12
content.old/example/collapsed/3rd-level/4th-level.md
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
# 4th Level of Menu
|
||||||
|
|
||||||
|
## Caesorum illa tu sentit micat vestes papyriferi
|
||||||
|
|
||||||
|
Inde aderam facti; Theseus vis de tauri illa peream. Oculos **uberaque** non
|
||||||
|
regisque vobis cursuque, opus venit quam vulnera. Et maiora necemque, lege modo;
|
||||||
|
gestanda nitidi, vero? Dum ne pectoraque testantur.
|
||||||
|
|
||||||
|
Venasque repulsa Samos qui, exspectatum eram animosque hinc, [aut
|
||||||
|
manes](http://www.creveratnon.net/apricaaetheriis), Assyrii. Cupiens auctoribus
|
||||||
|
pariter rubet, profana magni super nocens. Vos ius sibilat inpar turba visae
|
||||||
|
iusto! Sedes ante dum superest **extrema**.
|
||||||
28
content.old/example/collapsed/3rd-level/_index.md
Normal file
28
content.old/example/collapsed/3rd-level/_index.md
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
# 3rd Level of Menu
|
||||||
|
|
||||||
|
Nefas discordemque domino montes numen tum humili nexilibusque exit, Iove. Quae
|
||||||
|
miror esse, scelerisque Melaneus viribus. Miseri laurus. Hoc est proposita me
|
||||||
|
ante aliquid, aura inponere candidioribus quidque accendit bella, sumpta.
|
||||||
|
Intravit quam erat figentem hunc, motus de fontes parvo tempestate.
|
||||||
|
|
||||||
|
```c
|
||||||
|
iscsi_virus = pitch(json_in_on(eupViral),
|
||||||
|
northbridge_services_troubleshooting, personal(
|
||||||
|
firmware_rw.trash_rw_crm.device(interactive_gopher_personal,
|
||||||
|
software, -1), megabit, ergonomicsSoftware(cmyk_usb_panel,
|
||||||
|
mips_whitelist_duplex, cpa)));
|
||||||
|
if (5) {
|
||||||
|
managementNetwork += dma - boolean;
|
||||||
|
kilohertz_token = 2;
|
||||||
|
honeypot_affiliate_ergonomics = fiber;
|
||||||
|
}
|
||||||
|
mouseNorthbridge = byte(nybble_xmp_modem.horse_subnet(
|
||||||
|
analogThroughputService * graphicPoint, drop(daw_bit, dnsIntranet),
|
||||||
|
gateway_ospf), repository.domain_key.mouse(serverData(fileNetwork,
|
||||||
|
trim_duplex_file), cellTapeDirect, token_tooltip_mashup(
|
||||||
|
ripcordingMashup)));
|
||||||
|
module_it = honeypot_driver(client_cold_dvr(593902, ripping_frequency) +
|
||||||
|
coreLog.joystick(componentUdpLink), windows_expansion_touchscreen);
|
||||||
|
bashGigabit.external.reality(2, server_hardware_codec.flops.ebookSampling(
|
||||||
|
ciscNavigationBacklink, table + cleanDriver), indexProtocolIsp);
|
||||||
|
```
|
||||||
6
content.old/example/collapsed/_index.md
Normal file
6
content.old/example/collapsed/_index.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
bookCollapseSection: true
|
||||||
|
weight: 20
|
||||||
|
---
|
||||||
|
|
||||||
|
Hello World
|
||||||
52
content.old/example/hidden.md
Normal file
52
content.old/example/hidden.md
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
---
|
||||||
|
bookHidden: true
|
||||||
|
---
|
||||||
|
|
||||||
|
# This page is hidden in menu
|
||||||
|
|
||||||
|
# Quondam non pater est dignior ille Eurotas
|
||||||
|
|
||||||
|
## Latent te facies
|
||||||
|
|
||||||
|
Lorem markdownum arma ignoscas vocavit quoque ille texit mandata mentis ultimus,
|
||||||
|
frementes, qui in vel. Hippotades Peleus [pennas
|
||||||
|
conscia](http://gratia.net/tot-qua.php) cuiquam Caeneus quas.
|
||||||
|
|
||||||
|
- Pater demittere evincitque reddunt
|
||||||
|
- Maxime adhuc pressit huc Danaas quid freta
|
||||||
|
- Soror ego
|
||||||
|
- Luctus linguam saxa ultroque prior Tatiumque inquit
|
||||||
|
- Saepe liquitur subita superata dederat Anius sudor
|
||||||
|
|
||||||
|
## Cum honorum Latona
|
||||||
|
|
||||||
|
O fallor [in sustinui
|
||||||
|
iussorum](http://www.spectataharundine.org/aquas-relinquit.html) equidem.
|
||||||
|
Nymphae operi oris alii fronde parens dumque, in auro ait mox ingenti proxima
|
||||||
|
iamdudum maius?
|
||||||
|
|
||||||
|
reality(burnDocking(apache_nanometer),
|
||||||
|
pad.property_data_programming.sectorBrowserPpga(dataMask, 37,
|
||||||
|
recycleRup));
|
||||||
|
intellectualVaporwareUser += -5 * 4;
|
||||||
|
traceroute_key_upnp /= lag_optical(android.smb(thyristorTftp));
|
||||||
|
surge_host_golden = mca_compact_device(dual_dpi_opengl, 33,
|
||||||
|
commerce_add_ppc);
|
||||||
|
if (lun_ipv) {
|
||||||
|
verticalExtranet(1, thumbnail_ttl, 3);
|
||||||
|
bar_graphics_jpeg(chipset - sector_xmp_beta);
|
||||||
|
}
|
||||||
|
|
||||||
|
## Fronde cetera dextrae sequens pennis voce muneris
|
||||||
|
|
||||||
|
Acta cretus diem restet utque; move integer, oscula non inspirat, noctisque
|
||||||
|
scelus! Nantemque in suas vobis quamvis, et labori!
|
||||||
|
|
||||||
|
var runtimeDiskCompiler = home - array_ad_software;
|
||||||
|
if (internic > disk) {
|
||||||
|
emoticonLockCron += 37 + bps - 4;
|
||||||
|
wan_ansi_honeypot.cardGigaflops = artificialStorageCgi;
|
||||||
|
simplex -= downloadAccess;
|
||||||
|
}
|
||||||
|
var volumeHardeningAndroid = pixel + tftp + onProcessorUnmount;
|
||||||
|
sector(memory(firewire + interlaced, wired));
|
||||||
86
content.old/example/table-of-contents/_index.md
Normal file
86
content.old/example/table-of-contents/_index.md
Normal file
@ -0,0 +1,86 @@
|
|||||||
|
---
|
||||||
|
weight: 10
|
||||||
|
title: "Table of Contents"
|
||||||
|
---
|
||||||
|
|
||||||
|
# Ubi loqui
|
||||||
|
|
||||||
|
## Mentem genus facietque salire tempus bracchia
|
||||||
|
|
||||||
|
Lorem markdownum partu paterno Achillem. Habent amne generosi aderant ad pellem
|
||||||
|
nec erat sustinet merces columque haec et, dixit minus nutrit accipiam subibis
|
||||||
|
subdidit. Temeraria servatum agros qui sed fulva facta. Primum ultima, dedit,
|
||||||
|
suo quisque linguae medentes fixo: tum petis.
|
||||||
|
|
||||||
|
## Rapit vocant si hunc siste adspice
|
||||||
|
|
||||||
|
Ora precari Patraeque Neptunia, dixit Danae [Cithaeron
|
||||||
|
armaque](http://mersis-an.org/litoristum) maxima in **nati Coniugis** templis
|
||||||
|
fluidove. Effugit usus nec ingreditur agmen *ac manus* conlato. Nullis vagis
|
||||||
|
nequiquam vultibus aliquos altera *suum venis* teneas fretum. Armos [remotis
|
||||||
|
hoc](http://tutum.io/me) sine ferrea iuncta quam!
|
||||||
|
|
||||||
|
## Locus fuit caecis
|
||||||
|
|
||||||
|
Nefas discordemque domino montes numen tum humili nexilibusque exit, Iove. Quae
|
||||||
|
miror esse, scelerisque Melaneus viribus. Miseri laurus. Hoc est proposita me
|
||||||
|
ante aliquid, aura inponere candidioribus quidque accendit bella, sumpta.
|
||||||
|
Intravit quam erat figentem hunc, motus de fontes parvo tempestate.
|
||||||
|
|
||||||
|
iscsi_virus = pitch(json_in_on(eupViral),
|
||||||
|
northbridge_services_troubleshooting, personal(
|
||||||
|
firmware_rw.trash_rw_crm.device(interactive_gopher_personal,
|
||||||
|
software, -1), megabit, ergonomicsSoftware(cmyk_usb_panel,
|
||||||
|
mips_whitelist_duplex, cpa)));
|
||||||
|
if (5) {
|
||||||
|
managementNetwork += dma - boolean;
|
||||||
|
kilohertz_token = 2;
|
||||||
|
honeypot_affiliate_ergonomics = fiber;
|
||||||
|
}
|
||||||
|
mouseNorthbridge = byte(nybble_xmp_modem.horse_subnet(
|
||||||
|
analogThroughputService * graphicPoint, drop(daw_bit, dnsIntranet),
|
||||||
|
gateway_ospf), repository.domain_key.mouse(serverData(fileNetwork,
|
||||||
|
trim_duplex_file), cellTapeDirect, token_tooltip_mashup(
|
||||||
|
ripcordingMashup)));
|
||||||
|
module_it = honeypot_driver(client_cold_dvr(593902, ripping_frequency) +
|
||||||
|
coreLog.joystick(componentUdpLink), windows_expansion_touchscreen);
|
||||||
|
bashGigabit.external.reality(2, server_hardware_codec.flops.ebookSampling(
|
||||||
|
ciscNavigationBacklink, table + cleanDriver), indexProtocolIsp);
|
||||||
|
|
||||||
|
## Placabilis coactis nega ingemuit ignoscat nimia non
|
||||||
|
|
||||||
|
Frontis turba. Oculi gravis est Delphice; *inque praedaque* sanguine manu non.
|
||||||
|
|
||||||
|
if (ad_api) {
|
||||||
|
zif += usb.tiffAvatarRate(subnet, digital_rt) + exploitDrive;
|
||||||
|
gigaflops(2 - bluetooth, edi_asp_memory.gopher(queryCursor, laptop),
|
||||||
|
panel_point_firmware);
|
||||||
|
spyware_bash.statePopApplet = express_netbios_digital(
|
||||||
|
insertion_troubleshooting.brouter(recordFolderUs), 65);
|
||||||
|
}
|
||||||
|
recursionCoreRay = -5;
|
||||||
|
if (hub == non) {
|
||||||
|
portBoxVirus = soundWeb(recursive_card(rwTechnologyLeopard),
|
||||||
|
font_radcab, guidCmsScalable + reciprocalMatrixPim);
|
||||||
|
left.bug = screenshot;
|
||||||
|
} else {
|
||||||
|
tooltipOpacity = raw_process_permalink(webcamFontUser, -1);
|
||||||
|
executable_router += tape;
|
||||||
|
}
|
||||||
|
if (tft) {
|
||||||
|
bandwidthWeb *= social_page;
|
||||||
|
} else {
|
||||||
|
regular += 611883;
|
||||||
|
thumbnail /= system_lag_keyboard;
|
||||||
|
}
|
||||||
|
|
||||||
|
## Caesorum illa tu sentit micat vestes papyriferi
|
||||||
|
|
||||||
|
Inde aderam facti; Theseus vis de tauri illa peream. Oculos **uberaque** non
|
||||||
|
regisque vobis cursuque, opus venit quam vulnera. Et maiora necemque, lege modo;
|
||||||
|
gestanda nitidi, vero? Dum ne pectoraque testantur.
|
||||||
|
|
||||||
|
Venasque repulsa Samos qui, exspectatum eram animosque hinc, [aut
|
||||||
|
manes](http://www.creveratnon.net/apricaaetheriis), Assyrii. Cupiens auctoribus
|
||||||
|
pariter rubet, profana magni super nocens. Vos ius sibilat inpar turba visae
|
||||||
|
iusto! Sedes ante dum superest **extrema**.
|
||||||
64
content.old/example/table-of-contents/with-toc.md
Normal file
64
content.old/example/table-of-contents/with-toc.md
Normal file
@ -0,0 +1,64 @@
|
|||||||
|
---
|
||||||
|
title: With ToC
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
# Caput vino delphine in tamen vias
|
||||||
|
|
||||||
|
## Cognita laeva illo fracta
|
||||||
|
|
||||||
|
Lorem markdownum pavent auras, surgit nunc cingentibus libet **Laomedonque que**
|
||||||
|
est. Pastor [An](http://est.org/ire.aspx) arbor filia foedat, ne [fugit
|
||||||
|
aliter](http://www.indiciumturbam.org/moramquid.php), per. Helicona illas et
|
||||||
|
callida neptem est *Oresitrophos* caput, dentibus est venit. Tenet reddite
|
||||||
|
[famuli](http://www.antro-et.net/) praesentem fortibus, quaeque vis foret si
|
||||||
|
frondes *gelidos* gravidae circumtulit [inpulit armenta
|
||||||
|
nativum](http://incurvasustulit.io/illi-virtute.html).
|
||||||
|
|
||||||
|
1. Te at cruciabere vides rubentis manebo
|
||||||
|
2. Maturuit in praetemptat ruborem ignara postquam habitasse
|
||||||
|
3. Subitarum supplevit quoque fontesque venabula spretis modo
|
||||||
|
4. Montis tot est mali quasque gravis
|
||||||
|
5. Quinquennem domus arsit ipse
|
||||||
|
6. Pellem turis pugnabant locavit
|
||||||
|
|
||||||
|
## Natus quaerere
|
||||||
|
|
||||||
|
Pectora et sine mulcere, coniuge dum tincta incurvae. Quis iam; est dextra
|
||||||
|
Peneosque, metuis a verba, primo. Illa sed colloque suis: magno: gramen, aera
|
||||||
|
excutiunt concipit.
|
||||||
|
|
||||||
|
> Phrygiae petendo suisque extimuit, super, pars quod audet! Turba negarem.
|
||||||
|
> Fuerat attonitus; et dextra retinet sidera ulnas undas instimulat vacuae
|
||||||
|
> generis? *Agnus* dabat et ignotis dextera, sic tibi pacis **feriente at mora**
|
||||||
|
> euhoeque *comites hostem* vestras Phineus. Vultuque sanguine dominoque [metuit
|
||||||
|
> risi](http://iuvat.org/eundem.php) fama vergit summaque meus clarissimus
|
||||||
|
> artesque tinguebat successor nominis cervice caelicolae.
|
||||||
|
|
||||||
|
## Limitibus misere sit
|
||||||
|
|
||||||
|
Aurea non fata repertis praerupit feruntur simul, meae hosti lentaque *citius
|
||||||
|
levibus*, cum sede dixit, Phaethon texta. *Albentibus summos* multifidasque
|
||||||
|
iungitur loquendi an pectore, mihi ursaque omnia adfata, aeno parvumque in animi
|
||||||
|
perlucentes. Epytus agis ait vixque clamat ornum adversam spondet, quid sceptra
|
||||||
|
ipsum **est**. Reseret nec; saeva suo passu debentia linguam terga et aures et
|
||||||
|
cervix [de](http://www.amnem.io/pervenit.aspx) ubera. Coercet gelidumque manus,
|
||||||
|
doluit volvitur induta?
|
||||||
|
|
||||||
|
## Enim sua
|
||||||
|
|
||||||
|
Iuvenilior filia inlustre templa quidem herbis permittat trahens huic. In
|
||||||
|
cruribus proceres sole crescitque *fata*, quos quos; merui maris se non tamen
|
||||||
|
in, mea.
|
||||||
|
|
||||||
|
## Germana aves pignus tecta
|
||||||
|
|
||||||
|
Mortalia rudibusque caelum cognosceret tantum aquis redito felicior texit, nec,
|
||||||
|
aris parvo acre. Me parum contulerant multi tenentem, gratissime suis; vultum tu
|
||||||
|
occupat deficeret corpora, sonum. E Actaea inplevit Phinea concepit nomenque
|
||||||
|
potest sanguine captam nulla et, in duxisses campis non; mercede. Dicere cur
|
||||||
|
Leucothoen obitum?
|
||||||
|
|
||||||
|
Postibus mittam est *nubibus principium pluma*, exsecratur facta et. Iunge
|
||||||
|
Mnemonidas pallamque pars; vere restitit alis flumina quae **quoque**, est
|
||||||
|
ignara infestus Pyrrha. Di ducis terris maculatum At sede praemia manes
|
||||||
|
nullaque!
|
||||||
59
content.old/example/table-of-contents/without-toc.md
Normal file
59
content.old/example/table-of-contents/without-toc.md
Normal file
@ -0,0 +1,59 @@
|
|||||||
|
---
|
||||||
|
title: Without ToC
|
||||||
|
weight: 2
|
||||||
|
bookToc: false
|
||||||
|
---
|
||||||
|
|
||||||
|
# At me ipso nepotibus nunc celebratior genus
|
||||||
|
|
||||||
|
## Tanto oblite
|
||||||
|
|
||||||
|
Lorem markdownum pectora novis patenti igne sua opus aurae feras materiaque
|
||||||
|
illic demersit imago et aristas questaque posset. Vomit quoque suo inhaesuro
|
||||||
|
clara. Esse cumque, per referri triste. Ut exponit solisque communis in tendens
|
||||||
|
vincetis agisque iamque huic bene ante vetat omina Thebae rates. Aeacus servat
|
||||||
|
admonitu concidit, ad resimas vultus et rugas vultu **dignamque** Siphnon.
|
||||||
|
|
||||||
|
Quam iugulum regia simulacra, plus meruit humo pecorumque haesit, ab discedunt
|
||||||
|
dixit: ritu pharetramque. Exul Laurenti orantem modo, per densum missisque labor
|
||||||
|
manibus non colla unum, obiectat. Tu pervia collo, fessus quae Cretenque Myconon
|
||||||
|
crate! Tegumenque quae invisi sudore per vocari quaque plus ventis fluidos. Nodo
|
||||||
|
perque, fugisse pectora sorores.
|
||||||
|
|
||||||
|
## Summe promissa supple vadit lenius
|
||||||
|
|
||||||
|
Quibus largis latebris aethera versato est, ait sentiat faciemque. Aequata alis
|
||||||
|
nec Caeneus exululat inclite corpus est, ire **tibi** ostendens et tibi. Rigent
|
||||||
|
et vires dique possent lumina; **eadem** dixit poma funeribus paret et felix
|
||||||
|
reddebant ventis utile lignum.
|
||||||
|
|
||||||
|
1. Remansit notam Stygia feroxque
|
||||||
|
2. Et dabit materna
|
||||||
|
3. Vipereas Phrygiaeque umbram sollicito cruore conlucere suus
|
||||||
|
4. Quarum Elis corniger
|
||||||
|
5. Nec ieiunia dixit
|
||||||
|
|
||||||
|
Vertitur mos ortu ramosam contudit dumque; placabat ac lumen. Coniunx Amoris
|
||||||
|
spatium poenamque cavernis Thebae Pleiadasque ponunt, rapiare cum quae parum
|
||||||
|
nimium rima.
|
||||||
|
|
||||||
|
## Quidem resupinus inducto solebat una facinus quae
|
||||||
|
|
||||||
|
Credulitas iniqua praepetibus paruit prospexit, voce poena, sub rupit sinuatur,
|
||||||
|
quin suum ventorumque arcadiae priori. Soporiferam erat formamque, fecit,
|
||||||
|
invergens, nymphae mutat fessas ait finge.
|
||||||
|
|
||||||
|
1. Baculum mandataque ne addere capiti violentior
|
||||||
|
2. Altera duas quam hoc ille tenues inquit
|
||||||
|
3. Sicula sidereus latrantis domoque ratae polluit comites
|
||||||
|
4. Possit oro clausura namque se nunc iuvenisque
|
||||||
|
5. Faciem posuit
|
||||||
|
6. Quodque cum ponunt novercae nata vestrae aratra
|
||||||
|
|
||||||
|
Ite extrema Phrygiis, patre dentibus, tonso perculit, enim blanda, manibus fide
|
||||||
|
quos caput armis, posse! Nocendo fas Alcyonae lacertis structa ferarum manus
|
||||||
|
fulmen dubius, saxa caelum effuge extremis fixum tumor adfecit **bella**,
|
||||||
|
potentes? Dum nec insidiosa tempora tegit
|
||||||
|
[spirarunt](http://mihiferre.net/iuvenes-peto.html). Per lupi pars foliis,
|
||||||
|
porreximus humum negant sunt subposuere Sidone steterant auro. Memoraverit sine:
|
||||||
|
ferrum idem Orion caelum heres gerebat fixis?
|
||||||
3
content.old/features/_index.md
Normal file
3
content.old/features/_index.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
bookFlatSection: false
|
||||||
|
---
|
||||||
13
content.old/features/buttons.md
Normal file
13
content.old/features/buttons.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
# Buttons
|
||||||
|
|
||||||
|
Buttons are styled links that can lead to local page or external link.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```tpl
|
||||||
|
{{</* button relref="/" [class="..."] */>}}Get Home{{</* /button */>}}
|
||||||
|
{{</* button href="https://github.com/alex-shpak/hugo-book" */>}}Contribute{{</* /button */>}}
|
||||||
|
```
|
||||||
|
|
||||||
|
{{< button relref="/" >}}Get Home{{< /button >}}
|
||||||
|
{{< button href="https://github.com/alex-shpak/hugo-book" >}}Contribute{{< /button >}}
|
||||||
63
content.old/features/callouts.md
Normal file
63
content.old/features/callouts.md
Normal file
@ -0,0 +1,63 @@
|
|||||||
|
---
|
||||||
|
title: "Callouts"
|
||||||
|
---
|
||||||
|
|
||||||
|
## Callout support
|
||||||
|
|
||||||
|
Amethyst supports the same Admonition-callout syntax as Obsidian.
|
||||||
|
|
||||||
|
This includes
|
||||||
|
- 12 Distinct callout types (each with several aliases)
|
||||||
|
- Collapsable callouts
|
||||||
|
|
||||||
|
See [documentation on supported types and syntax here](https://help.obsidian.md/How+to/Use+callouts#Types).
|
||||||
|
|
||||||
|
## Showcase
|
||||||
|
|
||||||
|
> [!EXAMPLE] Examples
|
||||||
|
>
|
||||||
|
> Aliases: example
|
||||||
|
|
||||||
|
> [!note] Notes
|
||||||
|
>
|
||||||
|
> Aliases: note
|
||||||
|
|
||||||
|
> [!abstract] Summaries
|
||||||
|
>
|
||||||
|
> Aliases: abstract, summary, tldr
|
||||||
|
|
||||||
|
> [!info] Info
|
||||||
|
>
|
||||||
|
> Aliases: info, todo
|
||||||
|
|
||||||
|
> [!tip] Hint
|
||||||
|
>
|
||||||
|
> Aliases: tip, hint, important
|
||||||
|
|
||||||
|
> [!success] Success
|
||||||
|
>
|
||||||
|
> Aliases: success, check, done
|
||||||
|
|
||||||
|
> [!question] Question
|
||||||
|
>
|
||||||
|
> Aliases: question, help, faq
|
||||||
|
|
||||||
|
> [!warning] Warning
|
||||||
|
>
|
||||||
|
> Aliases: warning, caution, attention
|
||||||
|
|
||||||
|
> [!failure] Failure
|
||||||
|
>
|
||||||
|
> Aliases: failure, fail, missing
|
||||||
|
|
||||||
|
> [!danger] Error
|
||||||
|
>
|
||||||
|
> Aliases: danger, error
|
||||||
|
|
||||||
|
> [!bug] Bug
|
||||||
|
>
|
||||||
|
> Aliases: bug
|
||||||
|
|
||||||
|
> [!quote] Quote
|
||||||
|
>
|
||||||
|
> Aliases: quote, cite
|
||||||
45
content.old/features/columns.md
Normal file
45
content.old/features/columns.md
Normal file
@ -0,0 +1,45 @@
|
|||||||
|
# Columns
|
||||||
|
|
||||||
|
Columns help organize shorter pieces of content horizontally for readability.
|
||||||
|
|
||||||
|
|
||||||
|
```html
|
||||||
|
{{</* columns */>}} <!-- begin columns block -->
|
||||||
|
# Left Content
|
||||||
|
Lorem markdownum insigne...
|
||||||
|
|
||||||
|
<---> <!-- magic separator, between columns -->
|
||||||
|
|
||||||
|
# Mid Content
|
||||||
|
Lorem markdownum insigne...
|
||||||
|
|
||||||
|
<---> <!-- magic separator, between columns -->
|
||||||
|
|
||||||
|
# Right Content
|
||||||
|
Lorem markdownum insigne...
|
||||||
|
{{</* /columns */>}}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
{{< columns >}}
|
||||||
|
## Left Content
|
||||||
|
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||||
|
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||||
|
protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
|
||||||
|
Miseratus fonte Ditis conubia.
|
||||||
|
|
||||||
|
<--->
|
||||||
|
|
||||||
|
## Mid Content
|
||||||
|
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||||
|
stringit, frustra Saturnius uteroque inter!
|
||||||
|
|
||||||
|
<--->
|
||||||
|
|
||||||
|
## Right Content
|
||||||
|
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||||
|
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||||
|
protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
|
||||||
|
Miseratus fonte Ditis conubia.
|
||||||
|
{{< /columns >}}
|
||||||
22
content.old/features/details.md
Normal file
22
content.old/features/details.md
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
# Details
|
||||||
|
|
||||||
|
Details shortcode is a helper for `details` html5 element. It is going to replace `expand` shortcode.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
```tpl
|
||||||
|
{{</* details "Title" [open] */>}}
|
||||||
|
## Markdown content
|
||||||
|
Lorem markdownum insigne...
|
||||||
|
{{</* /details */>}}
|
||||||
|
```
|
||||||
|
```tpl
|
||||||
|
{{</* details title="Title" open=true */>}}
|
||||||
|
## Markdown content
|
||||||
|
Lorem markdownum insigne...
|
||||||
|
{{</* /details */>}}
|
||||||
|
```
|
||||||
|
|
||||||
|
{{< details "Title" open >}}
|
||||||
|
## Markdown content
|
||||||
|
Lorem markdownum insigne...
|
||||||
|
{{< /details >}}
|
||||||
35
content.old/features/expand.md
Normal file
35
content.old/features/expand.md
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
# Expand
|
||||||
|
|
||||||
|
Expand shortcode can help to decrease clutter on screen by hiding part of text. Expand content by clicking on it.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
### Default
|
||||||
|
|
||||||
|
```tpl
|
||||||
|
{{</* expand */>}}
|
||||||
|
## Markdown content
|
||||||
|
Lorem markdownum insigne...
|
||||||
|
{{</* /expand */>}}
|
||||||
|
```
|
||||||
|
|
||||||
|
{{< expand >}}
|
||||||
|
## Markdown content
|
||||||
|
Lorem markdownum insigne...
|
||||||
|
{{< /expand >}}
|
||||||
|
|
||||||
|
### With Custom Label
|
||||||
|
|
||||||
|
```tpl
|
||||||
|
{{</* expand "Custom Label" "..." */>}}
|
||||||
|
## Markdown content
|
||||||
|
Lorem markdownum insigne...
|
||||||
|
{{</* /expand */>}}
|
||||||
|
```
|
||||||
|
|
||||||
|
{{< expand "Custom Label" "..." >}}
|
||||||
|
## Markdown content
|
||||||
|
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||||
|
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||||
|
protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
|
||||||
|
Miseratus fonte Ditis conubia.
|
||||||
|
{{< /expand >}}
|
||||||
13
content.old/features/languages.md
Normal file
13
content.old/features/languages.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
---
|
||||||
|
title: "Chinese, Japanese, Korean Support (测试)"
|
||||||
|
---
|
||||||
|
|
||||||
|
## Chinese, Japanese, Korean Support
|
||||||
|
几乎在我们意识到之前，我们已经离开了地面。
|
||||||
|
|
||||||
|
우리가 그것을 알기도 전에 우리는 땅을 떠났습니다.
|
||||||
|
|
||||||
|
私たちがそれを知るほぼ前に、私たちは地面を離れていました。
|
||||||
|
|
||||||
|
## RTL
|
||||||
|
More information on configuring RTL languages like Arabic in the [config](setup/config.md) page.
|
||||||
28
content.old/features/latex.md
Normal file
28
content.old/features/latex.md
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
---
|
||||||
|
title: "LaTeX"
|
||||||
|
---
|
||||||
|
|
||||||
|
Block math works with two dollar signs `$$...$$`
|
||||||
|
|
||||||
|
$$f(x) = \int_{-\infty}^\infty
|
||||||
|
f\hat(\xi),e^{2 \pi i \xi x}
|
||||||
|
\,d\xi$$
|
||||||
|
|
||||||
|
Inline math also works with single dollar signs `$...$`. For example, Euler's identity but inline: $e^{i\pi} = -1$
|
||||||
|
|
||||||
|
Aligned equations work quite well:
|
||||||
|
|
||||||
|
$$
|
||||||
|
\begin{aligned}
|
||||||
|
a &= b + c \\ &= e + f \\
|
||||||
|
\end{aligned}
|
||||||
|
$$
|
||||||
|
|
||||||
|
And matrices
|
||||||
|
|
||||||
|
$$
|
||||||
|
\begin{bmatrix}
|
||||||
|
1 & 2 & 3 \\
|
||||||
|
a & b & c
|
||||||
|
\end{bmatrix}
|
||||||
|
$$
|
||||||
41
content.old/features/mermaid.md
Normal file
41
content.old/features/mermaid.md
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
# Mermaid Chart
|
||||||
|
|
||||||
|
[MermaidJS](https://mermaid-js.github.io/) is library for generating svg charts and diagrams from text.
|
||||||
|
|
||||||
|
{{< hint info >}}
|
||||||
|
**Override Mermaid Initialization Config**
|
||||||
|
|
||||||
|
To override the [initialization config](https://mermaid-js.github.io/mermaid/#/Setup) for Mermaid,
|
||||||
|
create a `mermaid.json` file in your `assets` folder!
|
||||||
|
{{< /hint >}}
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
{{< columns >}}
|
||||||
|
```tpl
|
||||||
|
{{</*/* mermaid [class="text-center"]*/*/>}}
|
||||||
|
stateDiagram-v2
|
||||||
|
State1: The state with a note
|
||||||
|
note right of State1
|
||||||
|
Important information! You can write
|
||||||
|
notes.
|
||||||
|
end note
|
||||||
|
State1 --> State2
|
||||||
|
note left of State2 : This is the note to the left.
|
||||||
|
{{</*/* /mermaid */*/>}}
|
||||||
|
```
|
||||||
|
|
||||||
|
<--->
|
||||||
|
|
||||||
|
{{< mermaid >}}
|
||||||
|
stateDiagram-v2
|
||||||
|
State1: The state with a note
|
||||||
|
note right of State1
|
||||||
|
Important information! You can write
|
||||||
|
notes.
|
||||||
|
end note
|
||||||
|
State1 --> State2
|
||||||
|
note left of State2 : This is the note to the left.
|
||||||
|
{{< /mermaid >}}
|
||||||
|
|
||||||
|
{{< /columns >}}
|
||||||
15
content.old/features/section/_index.md
Normal file
15
content.old/features/section/_index.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
---
|
||||||
|
bookCollapseSection: true
|
||||||
|
---
|
||||||
|
|
||||||
|
# Section
|
||||||
|
|
||||||
|
Section renders pages in section as definition list, using title and description.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```tpl
|
||||||
|
{{</* section */>}}
|
||||||
|
```
|
||||||
|
|
||||||
|
{{<section>}}
|
||||||
6
content.old/features/section/first-page.md
Normal file
6
content.old/features/section/first-page.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
# First page
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
|
||||||
|
|
||||||
|
<!--more-->
|
||||||
|
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||||
6
content.old/features/section/second-page.md
Normal file
6
content.old/features/section/second-page.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
# Second Page
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
|
||||||
|
|
||||||
|
<!--more-->
|
||||||
|
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||||
|
|
||||||
50
content.old/features/tabs.md
Normal file
50
content.old/features/tabs.md
Normal file
@ -0,0 +1,50 @@
|
|||||||
|
# Tabs
|
||||||
|
|
||||||
|
Tabs let you organize content by context, for example installation instructions for each supported platform.
|
||||||
|
|
||||||
|
```tpl
|
||||||
|
{{</* tabs "uniqueid" */>}}
|
||||||
|
{{</* tab "MacOS" */>}} # MacOS Content {{</* /tab */>}}
|
||||||
|
{{</* tab "Linux" */>}} # Linux Content {{</* /tab */>}}
|
||||||
|
{{</* tab "Windows" */>}} # Windows Content {{</* /tab */>}}
|
||||||
|
{{</* /tabs */>}}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
{{< tabs "uniqueid" >}}
|
||||||
|
{{< tab "MacOS" >}}
|
||||||
|
# MacOS
|
||||||
|
|
||||||
|
This is tab **MacOS** content.
|
||||||
|
|
||||||
|
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||||
|
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||||
|
protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
|
||||||
|
Miseratus fonte Ditis conubia.
|
||||||
|
{{< /tab >}}
|
||||||
|
|
||||||
|
{{< tab "Linux" >}}
|
||||||
|
|
||||||
|
# Linux
|
||||||
|
|
||||||
|
This is tab **Linux** content.
|
||||||
|
|
||||||
|
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||||
|
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||||
|
protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
|
||||||
|
Miseratus fonte Ditis conubia.
|
||||||
|
{{< /tab >}}
|
||||||
|
|
||||||
|
{{< tab "Windows" >}}
|
||||||
|
|
||||||
|
# Windows
|
||||||
|
|
||||||
|
This is tab **Windows** content.
|
||||||
|
|
||||||
|
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||||
|
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||||
|
protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
|
||||||
|
Miseratus fonte Ditis conubia.
|
||||||
|
{{< /tab >}}
|
||||||
|
{{< /tabs >}}
|
||||||
4
content.old/setup/_index.md
Normal file
4
content.old/setup/_index.md
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
linkTitle: "Getting Started"
|
||||||
|
weight: -5
|
||||||
|
---
|
||||||
114
content.old/setup/config.md
Normal file
114
content.old/setup/config.md
Normal file
@ -0,0 +1,114 @@
|
|||||||
|
---
|
||||||
|
title: "Customization"
|
||||||
|
tags:
|
||||||
|
- setup
|
||||||
|
weight: 0
|
||||||
|
---
|
||||||
|
|
||||||
|
# Configuration
|
||||||
|
Amethyst is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you'd like to get.
|
||||||
|
|
||||||
|
The majority of configuration can be found under `config.yaml`. An example, with descriptions for each setting, can be found [here](https://github.com/64bitpandas/amethyst/blob/main/config.yaml).
|
||||||
|
|
||||||
|
### Code Block Titles
|
||||||
|
To add code block titles with Amethyst:
|
||||||
|
|
||||||
|
1. Ensure that code block titles are enabled in the configuration:
|
||||||
|
|
||||||
|
```yaml {title="data/config.yaml", linenos=false}
|
||||||
|
enableCodeBlockTitle: true
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Add the `title` attribute to the desired [code block
|
||||||
|
fence](https://gohugo.io/content-management/syntax-highlighting/#highlighting-in-code-fences):
|
||||||
|
|
||||||
|
```markdown {linenos=false}
|
||||||
|
```yaml {title="data/config.yaml"}
|
||||||
|
enableCodeBlockTitle: true # example from step 1
|
||||||
|
```
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note** that if `{title=<my-title>}` is included, and code block titles are not
|
||||||
|
enabled, no errors will occur, and the title attribute will be ignored.
|
||||||
|
|
||||||
|
### HTML Favicons
|
||||||
|
If you would like to customize the favicons, you
|
||||||
|
can add them to the `data/config.yaml` file. The **default** without any set
|
||||||
|
`favicon` key is:
|
||||||
|
|
||||||
|
```html {title="layouts/partials/head.html", linenostart=15}
|
||||||
|
<link rel="shortcut icon" href="icon.png" type="image/png">
|
||||||
|
```
|
||||||
|
|
||||||
|
The default can be overridden by defining a value to the `favicon` key in your
|
||||||
|
`data/config.yaml` file. For example, here is a `List[Dictionary]` example format, which is
|
||||||
|
equivalent to the default:
|
||||||
|
|
||||||
|
```yaml {title="data/config.yaml", linenos=false}
|
||||||
|
favicon:
|
||||||
|
- { rel: "shortcut icon", href: "icon.png", type: "image/png" }
|
||||||
|
# - { ... } # Repeat for each additional favicon you want to add
|
||||||
|
```
|
||||||
|
|
||||||
|
In this format, the keys are identical to their HTML representations.
|
||||||
|
|
||||||
|
If you plan to add multiple favicons generated by a website (see list below), it
|
||||||
|
may be easier to define it as HTML. Here is an example which appends the
|
||||||
|
**Apple touch icon** to Amethyst's default favicon:
|
||||||
|
|
||||||
|
```yaml {title="data/config.yaml", linenos=false}
|
||||||
|
favicon: |
|
||||||
|
<link rel="shortcut icon" href="icon.png" type="image/png">
|
||||||
|
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
|
||||||
|
```
|
||||||
|
|
||||||
|
This second favicon will now be used as a web page icon when someone adds your
|
||||||
|
webpage to the home screen of their Apple device. If you are interested in more
|
||||||
|
information about the current and past standards of favicons, you can read
|
||||||
|
[this article](https://www.emergeinteractive.com/insights/detail/the-essentials-of-favicons/).
|
||||||
|
|
||||||
|
**Note** that all generated favicon paths, defined by the `href`
|
||||||
|
attribute, are relative to the `static/` directory.
|
||||||
|
|
||||||
|
### Graph View
|
||||||
|
To customize the Interactive Graph view, you can poke around `data/graphConfig.yaml`. The default configuration, with descriptions, can be found [here](https://github.com/64bitpandas/amethyst/blob/main/data/graphConfig.yaml).
|
||||||
|
|
||||||
|
### Language Support
|
||||||
|
[Chinese, Japanese, and Korean support](features/language.md) comes out of the box with Amethyst.
|
||||||
|
|
||||||
|
Want to support languages that read from right-to-left (like Arabic)? Hugo (and by proxy, Amethyst) supports this natively.
|
||||||
|
|
||||||
|
Follow the steps [Hugo provides here](https://gohugo.io/content-management/multilingual/#configure-languages) and modify your `config.yaml`
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
defaultContentLanguage: ar
|
||||||
|
languages:
|
||||||
|
ar:
|
||||||
|
languagedirection: rtl
|
||||||
|
title: مدونتي
|
||||||
|
weight: 2
|
||||||
|
```
|
||||||
|
|
||||||
|
# Custom Styles
|
||||||
|
Want to go even more in-depth? You can add custom CSS styling in `assets/_custom.scss`. If you'd like to target specific parts of the site, you can add ids and classes to the HTML partials in `/layouts/partials`.
|
||||||
|
|
||||||
|
### Changing the Color Scheme
|
||||||
|
The default color schemes for light mode and dark mode are located in `assets/_colors.scss`. You can replace the values for existing color variables for drop-in edits, or create new variables to reference in `_custom.scss`.
|
||||||
|
|
||||||
|
### Changing the Fonts
|
||||||
|
All fonts are defined in `assets/_fonts.scss`. There are examples for both local fonts (defined using `@font-face`) and webfonts (fetched with `@import` from a font distributor such as Google Fonts).
|
||||||
|
|
||||||
|
You can place all local fonts in the `static/fonts` folder.
|
||||||
|
|
||||||
|
### Partials
|
||||||
|
Partials are what dictate what gets rendered to the page. Want to change how pages are styled and structured? You can edit the appropriate layout in `/layouts`.
|
||||||
|
|
||||||
|
For example, the structure of the home page can be edited through `/layouts/index.html`. To customize the footer, you can edit `/layouts/partials/footer.html`
|
||||||
|
|
||||||
|
More info about partials on [Hugo's website.](https://gohugo.io/templates/partials/)
|
||||||
|
|
||||||
|
Still having problems? Checkout our [FAQ and Troubleshooting guide](setup/troubleshooting.md).
|
||||||
|
|
||||||
|
|
||||||
17
content.old/setup/custom Domain.md
Normal file
17
content.old/setup/custom Domain.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
---
|
||||||
|
title: "Custom Domain"
|
||||||
|
---
|
||||||
|
|
||||||
|
### Registrar
|
||||||
|
This step is only applicable if you are using a **custom domain**! If you are using a `<YOUR-USERNAME>.github.io` domain, you can skip this step.
|
||||||
|
|
||||||
|
For this last bit to take effect, you also need to create a CNAME record with the DNS provider you register your domain with (i.e. NameCheap, Google Domains).
|
||||||
|
|
||||||
|
GitHub has some [documentation on this](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site), but the tldr; is to
|
||||||
|
|
||||||
|
1. Go to your forked repository (`github.com/<YOUR-GITHUB-USERNAME>/amethyst`) settings page and go to the Pages tab. Under "Custom domain", type your custom domain, then click **Save**.
|
||||||
|
2. Go to your DNS Provider and create a CNAME record that points from your domain to `<YOUR-GITHUB-USERNAME.github.io.` (yes, with the trailing period).
|
||||||
|
|
||||||
|
*Example Configuration for Quartz*
|
||||||
|
3. Wait 30 minutes to an hour for the network changes to kick in.
|
||||||
|
4. Done!
|
||||||
98
content.old/setup/editing.md
Normal file
98
content.old/setup/editing.md
Normal file
@ -0,0 +1,98 @@
|
|||||||
|
---
|
||||||
|
title: "Editing Content"
|
||||||
|
tags:
|
||||||
|
- setup
|
||||||
|
weight: -4
|
||||||
|
---
|
||||||
|
|
||||||
|
## Editing
|
||||||
|
Amethyst runs on top of [Hugo](https://gohugo.io/) so all notes are written in [Markdown](https://www.markdownguide.org/getting-started/).
|
||||||
|
|
||||||
|
### Folder Structure
|
||||||
|
Here's a rough overview of what's what.
|
||||||
|
|
||||||
|
**All notes you want to publish should go in the `/content` folder.** To make edits, you can open any of the files and make changes directly and save it. You can organize content into any subfolder you'd like.
|
||||||
|
|
||||||
|
**To edit the main home page, open `/content/_index.md`.**
|
||||||
|
|
||||||
|
To create a link between notes in your garden, just create a normal link using Markdown pointing to the document in question. Please note that **all links should be relative to the root `/content` path**.
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
For example, I want to link this current document to `setup/config.md`.
|
||||||
|
[A link to the config page](setup/config.md)
|
||||||
|
```
|
||||||
|
|
||||||
|
Similarly, you can put local images anywhere in the `/content` folder.
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
Example image (source is in content/setup/images/example.png)
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also use wikilinks if that is what you are more comfortable with!
|
||||||
|
|
||||||
|
### Front Matter
|
||||||
|
Hugo is picky when it comes to metadata for files. Make sure that your title is double-quoted and that you have a title defined at the top of your file in the front matter like so. You can also add tags here as well.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
title: "Example Title"
|
||||||
|
tags:
|
||||||
|
- example-tag
|
||||||
|
---
|
||||||
|
|
||||||
|
Rest of your content here...
|
||||||
|
```
|
||||||
|
|
||||||
|
You can specify additional params in the front matter of individual pages:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# Set type to 'docs' if you want to render page outside of configured section or if you render section other than 'docs'
|
||||||
|
type = 'docs'
|
||||||
|
|
||||||
|
# Set page weight to re-arrange items in file-tree menu (if BookMenuBundle not set)
|
||||||
|
weight = 10
|
||||||
|
|
||||||
|
# (Optional) Set to 'true' to mark page as flat section in file-tree menu (if BookMenuBundle not set)
|
||||||
|
bookFlatSection = false
|
||||||
|
|
||||||
|
# (Optional) Set to hide nested sections or pages at that level. Works only with file-tree menu mode
|
||||||
|
bookCollapseSection = true
|
||||||
|
|
||||||
|
# (Optional) Set true to hide page or section from side menu (if BookMenuBundle not set)
|
||||||
|
bookHidden = false
|
||||||
|
|
||||||
|
# (Optional) Set 'false' to hide ToC from page
|
||||||
|
bookToC = true
|
||||||
|
|
||||||
|
# (Optional) If you have enabled BookComments for the site, you can disable it for specific pages.
|
||||||
|
bookComments = true
|
||||||
|
|
||||||
|
# (Optional) Set to 'false' to exclude page from search index.
|
||||||
|
bookSearchExclude = true
|
||||||
|
|
||||||
|
# (Optional) Set explicit href attribute for this page in a menu (if BookMenuBundle not set)
|
||||||
|
bookHref = ''
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Obsidian
|
||||||
|
Amethyst is built especially for use with [Obsidian](http://obsidian.md/) as a text editor.
|
||||||
|
|
||||||
|
See below for more information:
|
||||||
|
|
||||||
|
> 🔗 Step 3: [How to setup your Obsidian Vault to work with Amethyst](setup/obsidian.md)
|
||||||
|
|
||||||
|
## Previewing Changes
|
||||||
|
This step is purely optional and mostly for those who want to see the published version of their digital garden locally before opening it up to the internet. This is *highly recommended* but not required.
|
||||||
|
|
||||||
|
> 👀 Step 4: [Preview Changes](setup/preview%20changes.md)
|
||||||
|
|
||||||
|
For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.
|
||||||
|
|
||||||
|
## Publishing Changes
|
||||||
|
After you've finished editing your notes, you can publish them to the internet!
|
||||||
|
|
||||||
|
> 🌍 Step 5: [Hosting Amethyst online!](setup/hosting.md)
|
||||||
|
|
||||||
|
Having problems? Check out our [FAQ and Troubleshooting guide](setup/troubleshooting.md).
|
||||||
93
content.old/setup/hosting.md
Normal file
93
content.old/setup/hosting.md
Normal file
@ -0,0 +1,93 @@
|
|||||||
|
---
|
||||||
|
title: "Deploying Amethyst to the Web"
|
||||||
|
tags:
|
||||||
|
- setup
|
||||||
|
aliases:
|
||||||
|
- hosting
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hosting on GitHub Pages
|
||||||
|
Amethyst is designed to be effortless to deploy. If you forked and cloned Amethyst directly from the repository, everything should already be good to go! Follow the steps below.
|
||||||
|
|
||||||
|
### Enable GitHub Actions
|
||||||
|
By default, GitHub disables workflows from running automatically on Forked Repostories. Head to the 'Actions' tab of your forked repository and Enable Workflows to setup deploying your site!
|
||||||
|
|
||||||
|
*Enable GitHub Actions*
|
||||||
|
|
||||||
|
### Enable GitHub Pages
|
||||||
|
|
||||||
|
Head to the 'Settings' tab of your forked repository and go to the 'Pages' tab.
|
||||||
|
|
||||||
|
1. (IMPORTANT) Set the source to deploy from `master` (and not `hugo`) using `/ (root)`
|
||||||
|
2. Set a custom domain here if you have one!
|
||||||
|
|
||||||
|
*Enable GitHub Pages*
|
||||||
|
|
||||||
|
### Pushing Changes
|
||||||
|
To see your changes on the internet, we need to push it them to GitHub. Amethyst is a `git` repository so updating it is the same workflow as you would follow as if it were just a regular software project.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# Navigate to Amethyst folder
|
||||||
|
cd <path-to-amethyst>
|
||||||
|
|
||||||
|
# Commit all changes
|
||||||
|
git add .
|
||||||
|
git commit -m "message describing changes"
|
||||||
|
|
||||||
|
# Push to GitHub to update site
|
||||||
|
git push origin main
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: we specifically push to the `main` branch here. Our GitHub action automatically runs everytime a push to is detected to that branch and then updates the `deploy` branch for redeployment.
|
||||||
|
|
||||||
|
### Setting up the Site
|
||||||
|
Now let's get this site up and running. Never hosted a site before? No problem. Have a fancy custom domain you already own or want to use a subdomain? That's easy too.
|
||||||
|
|
||||||
|
> Don't want to use GitHub Pages? Continue following the instructions below, and simply point your hosting solution to serve the `deploy` branch with no additional build steps required.
|
||||||
|
|
||||||
|
Here, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`.
|
||||||
|
|
||||||
|
Make sure that your `baseURL` has a trailing `/`!
|
||||||
|
|
||||||
|
[Reference `config.yaml` here](https://github.com/64bitpandas/amethyst/blob/main/config.yaml)
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
baseURL: "https://<YOUR-DOMAIN>/"
|
||||||
|
```
|
||||||
|
|
||||||
|
If you are using this under a subdomain (e.g. `<YOUR-GITHUB-USERNAME>.github.io/amethyst/`), include the trailing `/`. **You need to do this especially if you are using GitHub!**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
baseURL: "https://<YOUR-GITHUB-USERNAME>.github.io/amethyst/"
|
||||||
|
```
|
||||||
|
|
||||||
|
Change `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a custom domain to use, you can use `<YOUR-USERNAME>.github.io`.
|
||||||
|
|
||||||
|
Please note that the `cname` field should *not* have any path `e.g. end with /amethyst` or have a trailing `/`.
|
||||||
|
|
||||||
|
[Reference `deploy.yaml` here](https://github.com/64bitpandas/amethyst/blob/main/.github/workflows/deploy.yaml)
|
||||||
|
|
||||||
|
```yaml {title=".github/workflows/deploy.yaml"}
|
||||||
|
- name: Deploy
|
||||||
|
uses: peaceiris/actions-gh-pages@v3
|
||||||
|
with:
|
||||||
|
github_token: ${{ secrets.GITHUB_TOKEN }} # this can stay as is, GitHub fills this in for us!
|
||||||
|
publish_dir: ./public
|
||||||
|
publish_branch: deploy
|
||||||
|
cname: <YOUR-DOMAIN>
|
||||||
|
```
|
||||||
|
|
||||||
|
Have a custom domain? [Learn how to set it up with Amethyst ](setup/custom%20Domain.md).
|
||||||
|
|
||||||
|
### Ignoring Files
|
||||||
|
Only want to publish a subset of all of your notes? Don't worry, Amethyst makes this a simple two-step process.
|
||||||
|
|
||||||
|
❌ [Excluding pages from being published](setup/ignore%20notes.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Now that your site is live, let's figure out how to make Amethyst really *yours*!
|
||||||
|
|
||||||
|
> Step 6: 🎨 [Customizing Amethyst](setup/config.md)
|
||||||
|
|
||||||
|
Having problems? Checkout our [FAQ and Troubleshooting guide](setup/troubleshooting.md).
|
||||||
30
content.old/setup/ignore notes.md
Normal file
30
content.old/setup/ignore notes.md
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
---
|
||||||
|
title: "Ignoring Notes"
|
||||||
|
---
|
||||||
|
|
||||||
|
Edit `ignoreFiles` in `config.yaml` to include paths you'd like to exclude from being rendered.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
...
|
||||||
|
ignoreFiles: [
|
||||||
|
"/content/templates/*",
|
||||||
|
"/content/private/*",
|
||||||
|
"<your path here>"
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
`ignoreFiles` supports the use of Regular Expressions (RegEx) so you can ignore patterns as well (e.g. ignoring all `.png`s by doing `\\.png$`).
|
||||||
|
To ignore a specific file, you can also add the tag `draft: true` to the frontmatter of a note.
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
---
|
||||||
|
title: Some Private Note
|
||||||
|
draft: true
|
||||||
|
---
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
More details in [Hugo's documentation](https://gohugo.io/getting-started/configuration/#ignore-content-and-data-files-when-rendering).
|
||||||
|
|
||||||
|
### Global Ignore
|
||||||
|
However, just adding to the `ignoreFiles` will only prevent the page from being access through Amethyst. If you want to prevent the file from being pushed to GitHub (for example if you have a public repository), you need to also add the path to the `.gitignore` file at the root of the repository.
|
||||||
BIN
content.old/setup/images/amethyst-screenshot.png
Normal file
BIN
content.old/setup/images/amethyst-screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 240 KiB |
BIN
content.old/setup/images/github-actions.png
Normal file
BIN
content.old/setup/images/github-actions.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 116 KiB |
BIN
content.old/setup/images/github-pages.png
Normal file
BIN
content.old/setup/images/github-pages.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 226 KiB |
BIN
content.old/setup/images/google-domains.png
Normal file
BIN
content.old/setup/images/google-domains.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 72 KiB |
BIN
content.old/setup/images/obsidian-settings.png
Normal file
BIN
content.old/setup/images/obsidian-settings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
40
content.old/setup/obsidian.md
Normal file
40
content.old/setup/obsidian.md
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
---
|
||||||
|
title: "Obsidian Vault Integration"
|
||||||
|
tags:
|
||||||
|
- setup
|
||||||
|
weight: -3
|
||||||
|
---
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
Obsidian is the preferred way to use Amethyst. You can either create a new Obsidian Vault or link one that your already have.
|
||||||
|
|
||||||
|
### New Vault
|
||||||
|
If you don't have an existing Vault, [download Obsidian](https://obsidian.md/) and create a new Vault in the `/content` folder that you created and cloned during the [setup](setup/setup.md) step.
|
||||||
|
|
||||||
|
### Linking an existing Vault (simple)
|
||||||
|
The easiest way to use an existing Vault is to copy all of your files (directory and hierarchies intact) into the `/content` folder.
|
||||||
|
|
||||||
|
### Linking an existing Vault (using git)
|
||||||
|
If you're editing in an existing vault and don't want to have to keep copying your files over, one solution is to create a new Git repository for just the notes you want to publish.
|
||||||
|
|
||||||
|
Then, in both your vault and in Amethyst, run the following command, replacing the link with one to your new repository:
|
||||||
|
```bash
|
||||||
|
git submodule add https://github.com/<YOUR_USERNAME>/<REPO_NAME> content
|
||||||
|
```
|
||||||
|
|
||||||
|
## Settings
|
||||||
|
Now that you've added your notes to Amethyst, let's fix some settings so that they play well.
|
||||||
|
|
||||||
|
1. Under Options > Files and Links, set the New link format to always use Absolute Path in Vault.
|
||||||
|
2. Go to Settings > Files & Links > Turn "on" automatically update internal links.
|
||||||
|
|
||||||
|
*Obsidian Settings*
|
||||||
|
|
||||||
|
## Templates
|
||||||
|
Inserting front matter everytime you want to create a new Note gets annoying really quickly. Luckily, Obsidian supports templates which makes inserting new content really easily.
|
||||||
|
|
||||||
|
**If you decide to overwrite the `/content` folder completely, don't remove the `/content/templates` folder!**
|
||||||
|
|
||||||
|
Head over to Options > Core Plugins and enable the Templates plugin. Then go to Options > Hotkeys and set a hotkey for 'Insert Template' (I recommend `[cmd]+T`). That way, when you create a new note, you can just press the hotkey for a new template and be ready to go!
|
||||||
|
|
||||||
|
> 👀 Step 4: [Preview Changes](setup/preview%20changes.md)
|
||||||
39
content.old/setup/preview changes.md
Normal file
39
content.old/setup/preview changes.md
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
---
|
||||||
|
title: "Preview Changes"
|
||||||
|
tags:
|
||||||
|
- setup
|
||||||
|
weight: -2
|
||||||
|
---
|
||||||
|
|
||||||
|
If you'd like to preview what your site looks like before deploying it to the internet, the following
|
||||||
|
instructions guide you through installing the proper dependencies to run it locally.
|
||||||
|
|
||||||
|
|
||||||
|
## Install `hugo-obsidian`
|
||||||
|
This step will generate the list of backlinks for Hugo to parse. Ensure you have [Go](https://golang.org/doc/install) (>= 1.16) installed.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install and link `hugo-obsidian` locally
|
||||||
|
go install github.com/jackyzha0/hugo-obsidian@latest
|
||||||
|
```
|
||||||
|
|
||||||
|
If you are running into an error saying that `command not found: hugo-obsidian`, make sure you set your `GOPATH` correctly! This will allow your terminal to correctly recognize hugo-obsidian as an executable.
|
||||||
|
|
||||||
|
Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated!
|
||||||
|
|
||||||
|
## Installing Hugo
|
||||||
|
Hugo is the static site generator that powers Amethyst. [Install Hugo with "extended" Sass/SCSS version](https://gohugo.io/getting-started/installing/) first. Then,
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Navigate to your local Amethyst folder
|
||||||
|
cd <location-of-your-local-amethyst>
|
||||||
|
|
||||||
|
# Start local server
|
||||||
|
make serve
|
||||||
|
|
||||||
|
# View your site in a browser at http://localhost:1313/
|
||||||
|
```
|
||||||
|
|
||||||
|
Now that you are happy with how your Amethyst instance looks, let's get it hosted!
|
||||||
|
|
||||||
|
> 🌍 Step 5: [Hosting Amethyst online!](setup/hosting.md)
|
||||||
37
content.old/setup/search.md
Normal file
37
content.old/setup/search.md
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
---
|
||||||
|
title: "Search"
|
||||||
|
---
|
||||||
|
|
||||||
|
Amethyst supports two modes of searching through content.
|
||||||
|
|
||||||
|
## Full-text
|
||||||
|
Full-text search is the default in Amethyst. It produces results that *exactly* match the search query. This is easier to setup but usually produces lower quality matches.
|
||||||
|
|
||||||
|
```yaml {title="data/config.yaml"}
|
||||||
|
# the default option
|
||||||
|
enableSemanticSearch: false
|
||||||
|
```
|
||||||
|
|
||||||
|
## Natural Language
|
||||||
|
Natural language search is powered by [Operand](https://beta.operand.ai/). It understands language like a person does and finds results that best match user intent. In this sense, it is closer to how Google Search works.
|
||||||
|
|
||||||
|
Natural language search tends to produce higher quality results than full-text search.
|
||||||
|
|
||||||
|
Here's how to set it up.
|
||||||
|
|
||||||
|
1. Login or Register for a new Operand account. Click the verification link sent to your email, and you'll be redirected to the dashboard. (Note) You do not need to enter a credit card to create an account, or get started with the Operand API. The first $10 of usage each month is free. To learn more, see pricing. If you go over your free quota, we'll (politely) reach out and ask you to configure billing.
|
||||||
|
2. Create your first index. On the dashboard, under "Indexes", enter the name and description of your index, and click "Create Index". Note down the ID of the index (obtained by clicking on the index name in the list of indexes), as you'll need it in the next step. IDs are unique to each index, and look something like `uqv1duxxbdxu`.
|
||||||
|
3. Click into the index you've created. Under "Index Something", select "SITEMAP" from the dropdown and click "Add Source".
|
||||||
|
4. For the "Sitemap.xml URL", put your deployed site's base URL followed by `sitemap.xml`. For example, for `amethyst.bencuan.me`, put `https://amethyst.bencuan.me/sitemap.xml`. Leave the URL Regex empty.
|
||||||
|
5. Get your API key. On the dashboard, under "API Keys", you can manage your API keys. If you don't already have an API key, click "Create API Key". You'll need this for the next step.
|
||||||
|
6. Open `data/config.yaml`. Set `enableSemanticSearch` to `true`, `operandApiKey` to your copied key, and `operandIndexId` to the ID of the index we created from earlier..
|
||||||
|
|
||||||
|
```yaml {title="data/config.yaml"}
|
||||||
|
# the default option
|
||||||
|
search:
|
||||||
|
enableSemanticSearch: true
|
||||||
|
operandApiKey: "jp9k5hudse2a828z98kxd6z3payi8u90rnjf"
|
||||||
|
operandIndexId: "s0kf3bd6tldw"
|
||||||
|
```
|
||||||
|
7. Push your changes to the site and wait for it to deploy.
|
||||||
|
8. Check the Operand dashboard and wait for your site to index. Enjoy natural language search powered by Operand!
|
||||||
32
content.old/setup/setup.md
Normal file
32
content.old/setup/setup.md
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
---
|
||||||
|
title: "Setup"
|
||||||
|
tags:
|
||||||
|
- setup
|
||||||
|
weight: -5
|
||||||
|
---
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
Setting up Amethyst requires a basic understanding of `git`. If you are unfamiliar, [this resource](https://resources.nwplus.io/2-beginner/how-to-git-github.html) is a great place to start!
|
||||||
|
|
||||||
|
### Forking
|
||||||
|
> A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.
|
||||||
|
|
||||||
|
Navigate to the GitHub repository for the Amethyst project:
|
||||||
|
|
||||||
|
📁 [Amethyst Repository](https://github.com/64bitpandas/amethyst)
|
||||||
|
|
||||||
|
Then, Fork the repository into your own GitHub account. If you don't have an account, you can make on for free [here](https://github.com/join). More details about forking a repo can be found on [GitHub's documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
|
||||||
|
|
||||||
|
### Cloning
|
||||||
|
After you've made a fork of the repository, you need to download the files locally onto your machine. Ensure you have `git`, then type the following command replacing `YOUR-USERNAME` with your GitHub username.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
git clone https://github.com/YOUR-USERNAME/amethyst
|
||||||
|
```
|
||||||
|
|
||||||
|
## Editing
|
||||||
|
Great! Now you have everything you need to start editing. If you're ready to start writing content already, check out the recommended flow for editing notes:
|
||||||
|
|
||||||
|
> ✏️ Step 2: [Editing Notes in Amethyst](setup/editing.md)
|
||||||
|
|
||||||
|
Having problems? Checkout our [FAQ and Troubleshooting guide](setup/troubleshooting.md).
|
||||||
79
content.old/setup/troubleshooting.md
Normal file
79
content.old/setup/troubleshooting.md
Normal file
@ -0,0 +1,79 @@
|
|||||||
|
---
|
||||||
|
title: "Troubleshooting and FAQ"
|
||||||
|
---
|
||||||
|
|
||||||
|
Still having trouble? Here are a list of common questions and problems people encounter when installing Amethyst.
|
||||||
|
|
||||||
|
### Does Amethyst have Latex support?
|
||||||
|
Yes! See [LaTeX](features/latex.md) for a brief demo.
|
||||||
|
|
||||||
|
### Can I use \<Obsidian Plugin\> in Amethyst?
|
||||||
|
Unless it produces direct Markdown output in the file, no. There currently is no way to bundle plugin code with Amethyst.
|
||||||
|
|
||||||
|
The easiest way would be to add your own HTML partial that supports the functionality you are looking for.
|
||||||
|
|
||||||
|
### My GitHub pages is just showing the README
|
||||||
|
Make sure you set the source to deploy from the `deploy` branch (and not `main`) using `/ (root)`! See more in the [hosting](/setup/hosting) guide
|
||||||
|
|
||||||
|
### Some of my pages have 'January 1, 0001' as the last modified date
|
||||||
|
This is a problem caused by `git` treating files as case-insensitive by default and some of your posts probably have capitalized file names. You can turn this off in your Amethyst by running this command.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# in the root folder (same folder as config.toml)
|
||||||
|
git config core.ignorecase true
|
||||||
|
|
||||||
|
# or globally (not recommended)
|
||||||
|
git config --global core.ignorecase true
|
||||||
|
```
|
||||||
|
|
||||||
|
### Can I publish only a subset of my pages?
|
||||||
|
Yes! Amethyst makes selective publishing really easy. Heres a guide on [excluding pages from being published](setup/ignore%20notes.md).
|
||||||
|
|
||||||
|
### Can I host this myself and not on GitHub Pages?
|
||||||
|
Yes! All built files can be found under `/public` in the `master` branch. More details under [hosting](setup/hosting.md).
|
||||||
|
|
||||||
|
### `command not found: hugo-obsidian`
|
||||||
|
Make sure you set your `GOPATH` correctly! This will allow your terminal to correctly recognize `hugo-obsidian` as an executable.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# Add the following 2 lines to your ~/.bash_profile
|
||||||
|
export GOPATH=/Users/$USER/go
|
||||||
|
export PATH=$GOPATH/bin:$PATH
|
||||||
|
|
||||||
|
# In your current terminal, to reload the session
|
||||||
|
source ~/.bash_profile
|
||||||
|
```
|
||||||
|
|
||||||
|
### How come my notes aren't being rendered?
|
||||||
|
You probably forgot to include front matter in your Markdown files. You can either setup [Obsidian](setup/obsidian.md) to do this for you or you need to manually define it. More details in [the 'how to edit' guide](setup/editing.md).
|
||||||
|
|
||||||
|
### My custom domain isn't working!
|
||||||
|
Walk through the steps in [the hosting guide](setup/hosting.md) again. Make sure you wait 30 min to 1 hour for changes to take effect.
|
||||||
|
|
||||||
|
### How do I setup Google Analytics?
|
||||||
|
You can edit it in `config.toml` and either use a V3 (UA-) or V4 (G-) tag.
|
||||||
|
|
||||||
|
### How do I change the content on the home page?
|
||||||
|
To edit the main home page, open `/content/_index.md`.
|
||||||
|
|
||||||
|
### How do I change the colours?
|
||||||
|
You can change the theme by editing `assets/custom.scss`. More details on customization and themeing can be found in the [customization guide](setup/config.md).
|
||||||
|
|
||||||
|
### How do I add images?
|
||||||
|
You can put images anywhere in the `/content` folder.
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
Example image (source is in content/setup/images/example.png)
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
### My Interactive Graph and Backlinks aren't up to date
|
||||||
|
By default, the `linkIndex.json` (which Amethyst needs to generate the Interactive Graph and Backlinks) are not regenerated locally. To set that up, see the guide on [local editing](setup/editing.md)
|
||||||
|
|
||||||
|
### Can I use React/Vue/some other framework?
|
||||||
|
Not out of the box. You could probably make it work by editing `/layouts/_default/single.html` but that's not what Amethyst is designed to work with. 99% of things you are trying to do with those frameworks you can accomplish perfectly fine using just vanilla HTML/CSS/JS.
|
||||||
|
|
||||||
|
## Still Stuck?
|
||||||
|
Amethyst isn't perfect! If you're still having troubles, file an issue in the GitHub repo with as much information as you can reasonably provide. Alternatively, [send me a message](https://bencuan.me/contact) using your preferred communication method!
|
||||||
|
|
||||||
|
🐛 [Submit an Issue](https://github.com/64bitpandas/amethyst/issues)
|
||||||
34
content.old/setup/updating.md
Normal file
34
content.old/setup/updating.md
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
title: "Updating"
|
||||||
|
aliases:
|
||||||
|
- update
|
||||||
|
---
|
||||||
|
|
||||||
|
Haven't updated Amethyst in a while and want all the cool new optimizations? On Unix/Mac systems you can run the following command for a one-line update! This command will show you a log summary of all commits since you last updated, press `q` to acknowledge this. Then, it will show you each change in turn and press `y` to accept the patch or `n` to reject it. Usually you should press `y` for most of these unless it conflicts with existing changes you've made!
|
||||||
|
|
||||||
|
```shell
|
||||||
|
make update
|
||||||
|
```
|
||||||
|
|
||||||
|
Or, if you don't want the interactive parts and just want to force update your local garden (this assumed that you are okay with some of your personalizations been overriden!)
|
||||||
|
|
||||||
|
```shell
|
||||||
|
make update-force
|
||||||
|
```
|
||||||
|
|
||||||
|
Or, manually checkout the changes yourself.
|
||||||
|
|
||||||
|
> [!warning] Warning!
|
||||||
|
>
|
||||||
|
> If you customized the files in `data/`, or anything inside `layouts/`, your customization may be overwritten!
|
||||||
|
> Make sure you have a copy of these changes if you don't want to lose them.
|
||||||
|
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# add Amethyst as a remote host
|
||||||
|
git remote add upstream git@github.com:64bitpandas/amethyst.git
|
||||||
|
|
||||||
|
# index and fetch changes
|
||||||
|
git fetch upstream
|
||||||
|
git checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss data
|
||||||
|
```
|
||||||
Loading…
Reference in New Issue
Block a user