⌘K
GitHub 2.4k
Getting Started › Introduction
v2.1.0 Stable 5 min read Deprecated Beta

Style Guide

Referensi visual semua komponen yang tersedia. Gunakan file ini sebagai pegangan saat menulis halaman dokumentasi baru.

Typography — h2

Sub section label — h3

Sub heading — h4

Ini adalah paragraf biasa dengan inline code, teks bold, teks italic, dan link dengan underline. Gunakan untuk menjelaskan konsep atau memberikan konteks.

Ini adalah blockquote. Cocok untuk kutipan, catatan penting, atau highlight kalimat dari sumber lain.

List

Unordered list:

  • Item pertama dengan inline code
  • Item kedua dengan teks biasa
  • Item ketiga
    • Sub item satu
    • Sub item dua

Ordered list:

  1. Langkah pertama
  2. Langkah kedua
  3. Langkah ketiga
    1. Sub langkah satu
    2. Sub langkah dua

Tags

Digunakan di .tag-row dalam page header.

default green blue red yellow

Badge new

Badge bisa disisipkan inline di dalam teks atau heading. Contoh: status default stable beta deprecated experimental internal

Callout

Info
Informasi tambahan yang berguna. Mendukung inline code di dalamnya. Warna biru.
Perhatian
Peringatan — sesuatu yang perlu diperhatikan sebelum melanjutkan. Warna kuning/oranye.
Berhasil
Konfirmasi atau hasil yang diharapkan. Warna hijau.
Bahaya
Peringatan kritis — tindakan ini tidak bisa dibatalkan atau bisa menyebabkan kerusakan data. Warna merah.
Prerequisites
HTML
HTML Beginner
CSS
CSS Intermediate
JS
JavaScript Advanced

Codeblock — Tanpa Copy Button

Cocok untuk output terminal atau struktur folder.

text
Ini adalah output teks biasa. Tidak ada copy button di header.

Codeblock — Dengan Copy Button

bash
npm install express ejs

Codeblock — Dengan Filename

index.js
const express = require('express') const app = express()

Codeblock — Syntax Highlight

Semua class highlight yang tersedia: .kw keyword, .fn function, .str string, .cm comment, .num number, .op operator, .var variable/property.

javascript
// ini comment — .cm const port = 3000 // .kw dan .num const app = express() // .fn app.locals.title = 'Velox' // .var dan .str if (port === 3000) { // .op app.listen(port) }

Codeblock — Line Highlight

Gunakan <span class="line-highlight"> membungkus baris yang ingin disorot.

javascript
const app = express() app.set('view engine', 'ejs') app.set('views', path.join(__dirname, 'views')) ← baris ini di-highlight app.use(express.static('public'))

Tabs — Codeblock Multi-Tab

const app = express() app.listen(3000)
import express from 'express' const app = express() app.listen(3000)
npm install express node index.js

Params Table

Parameter Type Keterangan
name required string Nama parameter wajib diisi.
options object Opsi tambahan. Default: {}
callback function Dipanggil setelah proses selesai dengan (err, result).

Steps

1
Install dependencies

Jalankan perintah berikut di root project kamu.

bash
npm install express ejs
2
Buat file index.js

Buat file entry point dan setup Express di dalamnya.

3
Jalankan server

Server siap diakses di http://localhost:3000.

Card Grid

Routing
Pelajari cara mendefinisikan route dan menangani request.
Baca selengkapnya →
Middleware
Gunakan middleware untuk memproses request sebelum sampai ke handler.
Baca selengkapnya →
Templates EJS
Render HTML dinamis dengan EJS dan layout system bawaan.
Baca selengkapnya →
Error Handling
Tangani error secara terpusat agar aplikasi tetap stabil.
Baca selengkapnya →

Divider

Divider biasa:

Divider dengan label:

atau

Compare Table

Fitur Velox Express (bare) Next.js
Setup cepat ✓ ✗ ✓
EJS support ✓ ~ ✗
File-based routing ~ ✗ ✓

Keyboard Shortcut List

Buka search
⌘ K
Navigasi ke atas
↑
Navigasi ke bawah
↓
Pilih item
Enter

File Tree

project/ ├── views/ │ ├── layout/ │ │ └── main.ejs │ ├── partials/ │ │ └── sidebar.ejs │ └── pages/ │ ├── introduction.ejs │ └── quick-start.ejs← baru ditambahkan ├── public/ │ └── css/ │ └── main.css ├── routes/ │ └── docs.js ├── index.js └── package.json

Image Wrap

Contoh screenshot
Gambar 1 — Tampilan halaman dokumentasi.

Doc Nav

Normal (ada prev dan next):

← Sebelumnya Installation

Halaman pertama (tidak ada prev):

Halaman terakhir (tidak ada next):

← Sebelumnya Database Integration