doctave - GitLite

KO | EN

gitlite — search

#javascript #python #react #typescript #llm #android #deep-learning #docker #nodejs #windows #awesome #security #ios #mcp

doctave

(★ 669)

A batteries-included developer documentation site generator

파일 탐색기

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

- - ci.yml
  - release.yml
- - .nojekyll
  - _head.html
  - CNAME
  - favicon.ico
- - assets.md
  - checks.md
  - custom-head-tag.md
  - custom-navigation.md
  - look-and-feel.md
  - markdown.md
  - math-notation.md
  - mermaid-js.md
  - README.md
- configuration.md
- contributor-guide.md
- deployment.md
- installing.md
- README.md
- tutorial.md
- - app.js
  - elasticlunr.min.js
  - gh-readme-logo.png
  - katex.min.css
  - katex.min.js
  - livereload.min.js
  - mermaid.min.js
  - normalize.css
  - prism-atom-dark.css
  - prism-ghcolors.css
  - prism.min.js
- broken_links_checker.rs
- build.rs
- config.rs
- docs_finder.rs
- error.rs
- frontmatter.rs
- init.rs
- lib.rs
- livereload_server.rs
- main.rs
- navigation.rs
- preview_server.rs
- serve.rs
- site.rs
- site_generator.rs
- watcher.rs
- navigation.html
- nested_navigation.html
- page.html
- search.html
- starter_examples.md
- starter_readme.md
- style.css
- build_cmd.rs
- init_cmd.rs
- serve_cmd.rs
- support.rs
.gitignore
.ignore
Cargo.lock
Cargo.toml
CHANGELOG.md
doctave.yaml
LICENSE
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/Doctave/doctave

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

cd doctave

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

2. Rust

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Rust (rustup) rustup으로 설치하면 cargo도 함께 설치됩니다.

$ cargo install --git https://github.com/Doctave/doctave --tag 0.4.2

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ cargo build가 에러 없이 끝나면 성공입니다. target/ 폴더에 실행 파일이 생성됩니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![CI Status](https://github.com/Doctave/doctave/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/Doctave/doctave/actions)
[![Docs](https://raw.githubusercontent.com/Doctave/doctave/master/docs/_include/assets/doctave-badge.png)](https://cli.doctave.com/)

![Doctave](https://raw.githubusercontent.com/Doctave/doctave/master/docs/_include/assets/doctave-logo-wide.png)

Doctave is an opinionated documentation site generator that converts your Markdown files into
a beautiful documentation site with minimal effort.

Doctave is not a generic static site generator - it is only meant for generating documentation sites
from Markdown. This allows the tool to be much simpler than other solutions, with fewer
configuration steps.

This open source tool is built and maintained by [Doctave.com](https://www.doctave.com).

* [Docs](https://cli.doctave.com) (built with Doctave)
* [Tutorial](https://cli.doctave.com/tutorial)

## Features

Doctave comes with a number of documentation-specific features out of the box. No plugins needed.

- [Mermaid.js](https://mermaid-js.github.io/) diagrams
- Offline full-text search
- Local live-reloading server
- Broken links checking
- Typesetting for mathematical formulas
- Responsive design
- Dark mode
- GitHub flavored markdown
- Minimal configuration
- Fast build times (Doctave is built with Rust)

## Hosting

Doctave-generated sites can be hosted on any static site hosting provider, such as [GitHub
Pages](https://pages.github.com/). You can also use [Doctave.com](https://www.doctave.com), which is
a specialized Doctave host, for free for public docs.

## Screenshots

You can customize the color scheme and logo to match your own style. Below are two examples: one
with Doctave's own color scheme, and another customized color scheme.

Light                                             | Dark                                                    |
--------------------------------------------------|---------------------------------------------------------|
![Exmple 1](https://raw.githubusercontent.com/Doctave/doctave/master/docs/_include/assets/example-1.png) | ![Example 2](https://raw.githubusercontent.com/Doctave/doctave/master/docs/_include/assets/example-1-dark.png) |
![Exmple 2](https://raw.githubusercontent.com/Doctave/doctave/master/docs/_include/assets/example-2.png) | ![Example 2](https://raw.githubusercontent.com/Doctave/doctave/master/docs/_include/assets/example-2-dark.png) |

## Installation

There are a few installation options for Doctave. If you would like another installation option,
please open an issue for it.

### Precompiled binaries

Doctave provides precompiled binaries for Mac, Linux, and Windows, which you can download from the
[latest release page](https://github.com/Doctave/doctave/releases/latest).

### Homebrew

Doctave maintains its own [homebrew tap](https://github.com/Doctave/homebrew-doctave), and you can
install Doctave via the following command:

```
$ brew install doctave/doctave/doctave
```

This will take a few minutes as Doctave is compiled from scratch for your machine.

### Cargo (Rust package manager)

You can also use the Rust package manager, Cargo, to install Doctave. Currently Doctave is not
listed on crates.io, but you can install it directly from GitHub:

```
$ cargo install --git https://github.com/Doctave/doctave --tag 0.4.2
```

## Getting started

Once you have Doctave installed, you can run the `init` command to create an initial docs site:

```
$ doctave init
```

Then, run the `serve` command to preview your site locally.

```
$ doctave serve

Doctave | Serve
Starting development server...

Server running on http://0.0.0.0:4001/

```