/architectural-modeling-basics

Presentation showing a really high-level approach to evaluating architectural modeling.

Primary LanguageSCSSMIT LicenseMIT

marp-slides-theme-template

Use this template!

This is a slightly less minimal template to create a [marp] site that:

  • can build [Sass] and use [CSS] custom themes
  • can be built and published on [GitHub Pages]

More specifically, the created site:

  • uses marp
  • uses Sass to manage common element styles, classes for specific slide types (i.e. title), and variables for theme colors
  • uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages.
  • has a DevContainer/CodeSpace configured with Marp and Markdown preview extensions ready
    • chrome is also added as it's needed in linux to make powerpoint slides

To get started with creating a site, just click "[use this template]"!

After completing the creation of your new site on GitHub, update it as needed:

Replace the content of the template pages

Update the following files to your own content:

  • slides/Slides.md (your new presentation)
  • README.md (information for those who access your site repo on GitHub)

Publishing your site on GitHub Pages

  1. In your newly created repo on GitHub:
    • go to the Settings tab -> Pages -> Build and deployment, then select Source: GitHub Actions.
    • if there were any failed Actions, go to the Actions tab and click on Re-run jobs.

Building and previewing your site locally

  1. Install Visual Studio Code if you haven't already.
  2. Install the Marp for VS Code extension from the Visual Studio Code marketplace.
  3. Open the slides/Slide.md file in VS Code.

Customization

You're free to customize sites that you create with this template, however you like!

Licensing and Attribution

This repository is licensed under the [MIT License]. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use!

The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party [starter workflows]. A copy of their MIT License is available in [actions/starter-workflows].

Resources