Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 2.23 KB

README.md

File metadata and controls

42 lines (29 loc) · 2.23 KB

Carlo Espino's Personal Site

This site uses deno as the JavaScript runtime and lume as the static site generator.

Dependencies

Deno 1.43.5

Development

  • Start a local server with live reload. 
    deno task serve
  • Build the static site under the build directory. 
    deno task lume

Structure

  • The src directory includes all the pages, data and static resources.
  • The src/_includes directory includes the layouts of the site.
  • The src/_data.yml file stores the shared data across pages.

Each page needs a front matter with a title variable. The title is set as the <h1> heading and in the <title> element.

There are two kinds of pages, the nav pages and the non-nav pages. The nav pages are listed in the navigation element and non-nav pages are listed in the homepage.

  • To make a page a nav page, set the variable is_nav_page to true, then set the nav_text variable to the text to display in the nav link, and then set the nav_order to a strictly increasing integer to set its order in the nav element.
  • The non-nav pages require no specific variables to be set, they'll get listed in the homepage and use the title variable as the text for the link to that page.

Plugins

  • Slugify URLs: converts all URLs in your HTML documents by removing or replacing potentially conflicting characteres like accents, spaces, etc.
  • Code Highlight: uses the highlight.js library to search and highlight the syntax code of any <pre><code> element.
  • Sitemap: generates a sitemap.xml file automatically with all your pages, which is useful for SEO. It also creates a robots.txt
  • Metas: generates <meta> tags in the HTML pages for Open graph, Twitter cards, Schema.org, and SEO purposes.
  • Internal Links: custom plugin WIP under plugins/internal_links.ts to implement WikiLinks (Internal Links) preprocessing for markdown files.

Deployment

Push to the master branch to deploy changes. A GitHub Action builds and deploys the static content to GitHub Pages.