Code Monkey home page Code Monkey logo

swikk's Introduction

swikk

A simple HTML/JS/CSS framework for building static documentation pages

Built using Svelte

Get Started

npm install

# for dev, starts server
npm run dev

# build release files (output to ./public)
npm run build

How to Structure Content

  • Markdown files go in ./public/md
  • Other static files referenced from Markdown files go in./public/file
  • Any static files linked from Markdown files in ./public/md need to use relative paths e.g. ![Image Alt Text](../file/example.png)
  • There needs to be at least ./public/md/_home.md and ./public/md/index.yaml
  • ./public/md/_home.md is the initial page that is loaded
  • index.yaml needs to be edited manually, it is not yet auto-generated

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.