Skip to content

Commit 7fb0daf

Browse files
committed
docs: migrate to MkDocs, fixes #1046
1 parent bd30786 commit 7fb0daf

File tree

11 files changed

+47
-24
lines changed

11 files changed

+47
-24
lines changed

.github/workflows/docs.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches: [main]
6+
7+
jobs:
8+
build-and-deploy:
9+
name: "build & deploy"
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
14+
- name: Deploy docs
15+
uses: mhausenblas/mkdocs-deploy-gh-pages@nomaterial
16+
env:
17+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
18+
CUSTOM_DOMAIN: docs.poac.dev

docs/CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/_config.yml

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/acknowledgements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Acknowledgements
1+
# Acknowledgements
22

33
This project exists thanks to all the people who contribute.
44

docs/hello-world.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
layout: default
3-
title: 4. Hello, World!
2+
title: Hello, World!
43
---
54

5+
# Hello, World!
6+
67
You can get started with just a few commands as the demo shows. Let's create a new Poac project:
78

89
```console
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
layout: default
3-
title: 1. Introduction
4-
permalink: /
2+
title: Introduction
53
---
64

5+
# Introduction
6+
77
Poac (pronounced as `/pəʊək/`) is a package manager and build system for C++ users, inspired by Cargo for Rust. Poac is designed as a structure-oriented build system, which means that as long as you follow Poac's designated project structure, you almost do not need configurations, much less a language to build, unlike CMake. If you do not like writing a bunch of configurations to build your project, Poac might be best suited. Currently, the supported project structure can be known by looking at this repository since Poac can build itself.

docs/installation.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
layout: default
3-
title: 3. Installation
4-
---
1+
# Installation
52

63
[![Packaging status](https://repology.org/badge/vertical-allrepos/poac.svg)](https://repology.org/project/poac/versions)
74

docs/package-layout.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
2-
layout: default
3-
title: 6. Package Layout
2+
title: Package Layout
43
---
54

5+
# Package Layout
6+
67
* `src/**`: contains source files and private header files
78
* `include/**`: contains public header files

docs/usage.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
layout: default
3-
title: 5. Usage
4-
---
1+
# Usage
52

63
## Start a new project with Poac
74

docs/why-poac.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
layout: default
3-
title: 2. Why Poac?
2+
title: Why Poac?
43
---
54

5+
# Why Poac?
6+
67
C++ is often considered a complex language and unconsciously avoided by many. The absence of a definitive package manager and the unfamiliar syntax of build systems like [CMake](https://cmake.org) make it seem difficult to set up a C++ environment, leaving people hesitant.
78

89
To simplify the process and allow users to develop applications and libraries without worrying about [CMake](https://cmake.org), I created a package manager and build system with an intuitive interface, similar to [Cargo](https://github.com/rust-lang/cargo). This allows developers to focus on learning C++ without any hindrances. Additionally, I aim to integrate with other build systems and package managers, providing a seamless transition between development environments.
@@ -15,4 +16,4 @@ Poac is originated from `cpp` but designed to prioritize ease of typing and redu
1516

1617
Despite C++ often being overlooked for product development, I believe that Poac can help to promote it as a fun language. Amemiya and Mizutani argue that the sound of `/p/` is associated with a bright and soft impression among Japanese consonants (157)[^1]. In the same way, I believe that Poac's name can convey a similarly positive impression.
1718

18-
[^1]: Amemiya, T., & Mizutani, S. (2006). On the Basic Affective Dimensions of Japanese Onomatopoeia and the Basic Level of Japanese Phonesthemes. 関西大学社会学部紀要, 37(2), 139–166. https://hdl.handle.net/10112/12311
19+
[^1]: Amemiya, T., & Mizutani, S. (2006). On the Basic Affective Dimensions of Japanese Onomatopoeia and the Basic Level of Japanese Phonesthemes. 関西大学社会学部紀要, 37(2), 139–166. <https://hdl.handle.net/10112/12311>

0 commit comments

Comments
 (0)