시작하기

이 문서에서는 Wikven으로 기본적인 Hello World 문서를 만듭니다.

이 문서는 유닉스 계열 셸을 전제합니다. 단독 실행 바이너리는 Linux 전용이므로, macOS나 Windows에서는 Docker 이미지를 사용하십시오.

Wikven은 위키텍스트 디렉터리로부터 정적 웹사이트를 빌드합니다. 설치 방법은 세 가지로, 단독 실행 바이너리, Docker 이미지, 소스에서 빌드입니다. 이 안내서에서는 바이너리나 Docker를 사용하니, 가지고 있는 쪽을 고르십시오.

요구 사항

• 단독 실행 바이너리(Linux), 또는 Docker(모든 플랫폼). 둘 중 하나를 구하려면 설치를 참고하십시오.

---

소스 디렉터리를 만들고 위키텍스트 파일을 추가합니다. .wikitext로 끝나는 파일은 모두 위키 문서가 됩니다. 진입 문서의 이름을 index로 지으면 index.html로 빌드되는데, 이는 브라우저가 사이트 루트에서 여는 파일입니다.

mkdir src
echo 'Hello, World!' > src/index.wikitext

그런 다음 사이트를 빌드합니다. 렌더링된 문서는 dist/에 기록됩니다. Wikven을 실행하는 방식에 맞는 탭을 고르십시오:

BinaryDocker

src/가 있는 디렉터리에서 실행합니다 (설치하려면 설치 참고):

wikven build

소스 디렉터리와 출력 디렉터리를 컨테이너에 마운트합니다:

docker run --rm \
  -v "$(pwd)/src:/workspace/src" \
  -v "$(pwd)/dist:/workspace/dist" \
  ghcr.io/chaotic-ground/wikven

태그 없는 이미지는 최신 빌드를 따릅니다. 특정 버전으로 고정하려면 :1.0.0 같은 릴리스 태그를 붙이십시오.

사이트를 로컬에서 미리 보고, http://localhost:8080을 엽니다:

BinaryDocker

wikven serve

docker run --rm -p 8080:8080 \
  -v "$(pwd)/dist:/workspace/dist" \
  ghcr.io/chaotic-ground/wikven serve

dist/index.html을 직접 열어도 되지만, 일부 링크와 자산은 서빙할 때만 올바르게 해석됩니다. 온라인에 게시하려면 배포하기를 참고하십시오.

사이트 제목 설정하기

설정을 위해 src 디렉터리에 .wikven.yaml 파일을 만듭니다.

cat <<EOF > src/.wikven.yaml
config:
  Sitename: My Site
EOF

앞서와 같은 명령으로 다시 빌드하면 사이트 제목이 "My Site"가 됩니다.

두 번째 문서 추가하기

모든 .wikitext 파일은 문서가 됩니다. 하나를 더 추가하고 [[...]]로 첫 문서에서 그 문서로 링크합니다:

echo 'This is the help page.' > src/Help.wikitext
echo 'Read the [[Help]].' >> src/index.wikitext

다시 빌드하면 홈 문서가 이제 Help.html로 링크되며, 그 링크는 서버 없이도 동작합니다. 파일 이름이 문서 제목과 이름공간에 어떻게 대응되는지는 문서를 참고하십시오.

틀 추가하기

Markdown 대신 Wikven을 택하는 주된 이유인 틀은 콘텐츠를 재사용할 수 있게 해 줍니다. 소스에 Template: 문서를 두고 {{...}}로 끼워 넣습니다:

echo "'''Note:''' {{{1}}}" > "src/Template:Note.wikitext"
echo '{{Note|Back up your wiki first.}}' >> src/index.wikitext

다시 빌드하면 홈 문서에 이제 알림이 표시됩니다. 매개변수 등에 대해서는 문서의 틀 섹션을 참고하십시오.

← Installation

Pages →