imml - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #golang #rust #deep-learning #docker #windows #kubernetes #vue #security #pytorch #ios #open-source

imml

(★ 174)

⚡ Create minimalist, blazing fast no-javascript websites from a single, portable plain text file

파일 탐색기

최종 버전 다운로드 (.zip)

- - build-deploy-editor.yml
- - imml-px-logo.png
- imml.language.js
- index.html
- index.js
- page.imml
- style.css
- vite.config.js
- - imml.es.js
  - imml.umd.js
- .npmignore
- base.css
- imml.js
- make.js
- style.css
- vite.config.js
.gitignore
package-lock.json
package.json
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/leoncvlt/imml

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd imml

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# `imml`

`imml` (indented markdown markup language) is a markup language and static site generator whose purpose is to create minimalist, blazing fast no-javascript websites from a single, portable plain text file.

The project was born from the desire to have a process to build a personal website which doesn't get more complicated than editing a single text file and calling it a day. Could be the perfect choice for your blog, public brain dump, recipe list, no-fuss portfolio, low-fi zine, or anything you can think of.

### features
- your whole website is a single, portable, offline, private plain text file
- blazing fast to load and build
- no javascript
- it's a [better motherfucking website](http://bettermotherfuckingwebsite.com/)
- makes you understand that _perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away_

### using `imml`
Visit https://leoncvlt.github.io/imml/ for a web-based `imml` editor. Write in the editor on the left side and it will be parsed in real-time into the results shown on the right. The web-based editor saves to localstorage, so feel free to come back to it later on - or you can manually save and load a file by using the toolbar buttons on the top left. The export button exports your site as a single .html file.

Alternatively, write a file locally on your machine and then, with node.js installed, run `npx imml <path to your text file>` to generate a minified html file. Run `npx imml --help` or [click here](#cli) to find out more about the command line tool.

### writing guide
Wrap text between `[square brackets]` to create a page and a link to it, then indent and write markdown to create the content for that page. The first page in the imml document is your home. Nest pages to create a site structure. For more advanced usage, check the [detailed writing guide](https://github.com/leoncvlt/imml/wiki/Writing-Guide) in the wiki.

### using as a library
```js
import { parse, render } from "imml";

// import the default style, or make your own
import "imml/lib/style.css";

const text = `
[home]
    Hello World!
    [foo]
        bar
`

const data = parse(text);
render(data, window.document);
```

## Support [![Buy me a coffee](https://img.shields.io/badge/-buy%20me%20a%20coffee-lightgrey?style=flat&logo=buy-me-a-coffee&color=FF813F&logoColor=white "Buy me a coffee")](https://www.buymeacoffee.com/leoncvlt)
If this tool has proven useful to you, consider [buying me a coffee](https://www.buymeacoffee.com/leoncvlt) to support development of this and [many other projects](https://github.com/leoncvlt?tab=repositories).