From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mail-a.sr.ht; dkim=pass header.d=maniero.me header.i=@maniero.me Received: from antelope.elm.relay.mailchannels.net (antelope.elm.relay.mailchannels.net [23.83.212.4]) by mail-a.sr.ht (Postfix) with ESMTPS id 1CEC6200B6 for <~johnnyrichard/olang-devel@lists.sr.ht>; Sat, 17 Feb 2024 16:27:18 +0000 (UTC) X-Sender-Id: hostingeremail|x-authuser|carlos@maniero.me Received: from relay.mailchannels.net (localhost [127.0.0.1]) by relay.mailchannels.net (Postfix) with ESMTP id 50E2C6C20A9 for <~johnnyrichard/olang-devel@lists.sr.ht>; Sat, 17 Feb 2024 16:27:17 +0000 (UTC) Received: from nl-srv-smtpout4.hostinger.io (unknown [127.0.0.6]) (Authenticated sender: hostingeremail) by relay.mailchannels.net (Postfix) with ESMTPA id 5C96B6C1D9C for <~johnnyrichard/olang-devel@lists.sr.ht>; Sat, 17 Feb 2024 16:27:15 +0000 (UTC) ARC-Seal: i=1; s=arc-2022; d=mailchannels.net; t=1708187235; a=rsa-sha256; cv=none; b=hhKGRaSNlYcZ2OBq6qYoXe9vIZUhR7Q2QT0MKQJjwdw7FAFq4IiNGiK5vaeDY3bJZ1wJ0K VdIxXHJMZ3R8TT/knI6Gag74ZDoRvp/dSh/3V6zk0Z3a5LGRiae5sbMze5ghiBIeAaKXse MQLWQiSl5muzgAJhB02UuyPzdyp+xAvj9EyWEm8HIUQcEmtcZlgUUYUj9peF/I/Mpnu4RC zOuxuhXI/Xc4nYRr878+Zs57iCvHv1TwXarYUdhzC+fDWdDnGypdkszAbCOfkEbL5vGSdT sOx+eJY+YVrf4Naps/6WPiOlRn3g6uKeY6oZJfymLT9rO4A/OziFFXzJcLuwQQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=mailchannels.net; s=arc-2022; t=1708187235; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding:dkim-signature; bh=0EPZM0oubLQw5UhEoO3rObgqtgMcrjMPTZF9mRhgKZg=; b=MqNkMJ2Kkj+glTv5tokyQmFLAiaitBi4BGIJjUJRuXlv2o8h4lhTTDNGWLYFc2ZDUVdufL YEJ+CzF/QpjcKtB7+K8K/72wbIa9gwDb+zPKOJs34Yrdxv0LYxDeNi0x8o69JT6kxChx1T /ZWL8UqqeuwmYgX1HdCiZ6dsZZgMadZJUsJ0NHpD5VVv1C7R6Ledr61+XktrvAh5VCq46j mtZSx4ToIYtnh4Nh8VA+D+K4PFB8oDj/4Q0SPNNhZRC3xckpljcf+4i7Rb4/2zhegLvD++ 0s2A0tf1AjIQvX2XNcTaVYKAFjCDCTic3L0TisT9tpCdQtx0RKzNsLOLJ8YRIA== ARC-Authentication-Results: i=1; rspamd-6bdc45795d-qx4xh; auth=pass smtp.auth=hostingeremail smtp.mailfrom=carlos@maniero.me X-Sender-Id: hostingeremail|x-authuser|carlos@maniero.me X-MC-Relay: Neutral X-MailChannels-SenderId: hostingeremail|x-authuser|carlos@maniero.me X-MailChannels-Auth-Id: hostingeremail X-Dime-Absorbed: 72d263a634df90b2_1708187237060_2394071141 X-MC-Loop-Signature: 1708187237060:1920081814 X-MC-Ingress-Time: 1708187237059 Received: from nl-srv-smtpout4.hostinger.io (nl-srv-smtpout4.hostinger.io [145.14.159.45]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384) by 100.97.82.31 (trex/6.9.2); Sat, 17 Feb 2024 16:27:17 +0000 From: Carlos Maniero DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=maniero.me; s=hostingermail1; t=1708187234; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=0EPZM0oubLQw5UhEoO3rObgqtgMcrjMPTZF9mRhgKZg=; b=ZHDxYxIzCqjEZWLGJNnHHtke4rXwS3OllqSpKgBKFeFYElG8f2ELe3iP1VHd9djl3m2HBQ m8VytU/ZN5r3VGVgMj34OiGgwIh5l/WmhYsO8JqA8QoxQEo3URzluh+jWkAlD2vLjZWtkM VmY4xC/ALuatpvrjPQcLUiMKZ3SROKwBBSUq8xkOKeW/TixqqfwJ+rWIUmPLzvuNGkezEC rsLp65a3MW/nXkWbOzCoA9sRXoGcK/LKlAgPK/WJgwZYODSvJSoBt4rj9zNAw5ElUcn3Qb otEuuhRvFSZqu8ufKB4lo4S/TuAqsEmLz03UGil3n6KP5HdPg40S7GdvK7uDYQ== To: ~johnnyrichard/olang-devel@lists.sr.ht Cc: Carlos Maniero Subject: [PATCH olang] docs: add pandoc Date: Sat, 17 Feb 2024 13:22:39 -0300 Message-Id: <20240217162239.3206803-1-carlos@maniero.me> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-CM-Analysis: v=2.4 cv=DIOJ4TNb c=1 sm=1 tr=0 ts=65d0de61 a=5+VMC1FZ3J4mVPAKpPmAqg==:117 a=5+VMC1FZ3J4mVPAKpPmAqg==:17 a=IkcTkHD0fZMA:10 a=MKtGQD3n3ToA:10 a=1oJP67jkp3AA:10 a=BXDaF_L80NYA:10 a=bwGbKnmsAAAA:8 a=9c2MSLdHra3ktRqD7G4A:9 a=F-rmMKMRcP5nj4Ea:21 a=3ZKOabzyN94A:10 a=QEXdDO2ut3YA:10 a=Lcls91HMl2cA:10 a=nuVVIWbBudwLbAahYuja:22 X-CM-Envelope: MS4xfIyEgbAQT7hS+NQbyj157FDG78dUJ1c19r8n4ePN9ehbA/1S/hflNAAFcuInYCYUJU9LmryRCwfOqpUBJwrt0vuD+FAjxVTb8kApb4xFug8h5DqGeCWn kAwq8nG9zshqigXbDU7+Y0klb+8kJMZFPJoB6K6t9jfJpL0J5WgAXtfTn9LpkCn692OA48g+u8EbW2LcsPR/SNA6/9kEw24w4MlmNwcCpz72s/FmbGk3AQ8O uqQ3y46dCmCOfSxBjJk9JA== X-AuthUser: carlos@maniero.me X-TUID: vuVElTAzO5M0 We replaced the sphinx with pandoc. This commit makes the initial setup with a basic landing page. Signed-off-by: Carlos Maniero --- docs/Makefile | 24 +++++++++++++++ docs/index.md | 27 +++++++++++++++++ docs/pages/getting-started.md | 3 ++ docs/pages/hacking.md | 3 ++ docs/template.html | 55 +++++++++++++++++++++++++++++++++++ 5 files changed, 112 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/index.md create mode 100644 docs/pages/getting-started.md create mode 100644 docs/pages/hacking.md create mode 100644 docs/template.html diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..e5b7154 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,24 @@ +PANDOC := pandoc +INDEX := index.md +BUILD_DIR := build +TARGET := $(BUILD_DIR)/index.html +PAGES_DIR := pages +PAGES := $(wildcard $(PAGES_DIR)/*.md) +HTML_PAGES := $(patsubst $(PAGES_DIR)/%.md, $(BUILD_DIR)/$(PAGES_DIR)/%.html, $(PAGES)) + +.PHONY: all +all: $(BUILD_DIR) $(TARGET) $(PAGES) + +.PHONY: clean +clean: + rm -rf build/ + +$(TARGET): $(HTML_PAGES) + $(PANDOC) -s --template template.html -f markdown -t html $(INDEX) > $(TARGET) + +$(BUILD_DIR): + @mkdir -p $@ + @mkdir -p $@/$(PAGES_DIR) + +$(BUILD_DIR)/$(PAGES_DIR)/%.html: $(PAGES_DIR)/%.md + $(PANDOC) -s --template template.html -f markdown -t html $< > $@ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..b6d5c1a --- /dev/null +++ b/docs/index.md @@ -0,0 +1,27 @@ +% Welcome to olang documentation + +The zero programming language. + +## olang manifest + +We, as developers, value the modern programming languages that allow us to +produce reliable code in a short time span. However, we, as programmers, also +lament that these same languages have diminished the joy of programming by +imposing unnecessary constraints and complexities on our creative expression. + +That is why we are creating a new programming language that may not be suitable +for most commercial applications, but that can be enjoyed in the places where +it is meant to be used: on system applications. + +olang is a deterministic system language that follows two principles: + +- **olang fights complexity** by providing a simple syntax with a low level of abstraction; +- **olang doesn't babysit programmers** and therefore the compiler only checks semantics. + +olang maintainers + +### Subscribe olang's development mailing list. + +If you want to subscribe to the mailing list, you can achieve it by sending an +email to +[~johnnyrichard/olang-devel+subscribe@lists.sr.ht](mailto:~johnnyrichard/olang-devel+subscribe@lists.sr.ht?subject=Subscribe&body=Subscribe) diff --git a/docs/pages/getting-started.md b/docs/pages/getting-started.md new file mode 100644 index 0000000..af258df --- /dev/null +++ b/docs/pages/getting-started.md @@ -0,0 +1,3 @@ +% Getting stated (WIP) + +WIP diff --git a/docs/pages/hacking.md b/docs/pages/hacking.md new file mode 100644 index 0000000..2bb1338 --- /dev/null +++ b/docs/pages/hacking.md @@ -0,0 +1,3 @@ +% Hacking WIP + +WIP diff --git a/docs/template.html b/docs/template.html new file mode 100644 index 0000000..98cc348 --- /dev/null +++ b/docs/template.html @@ -0,0 +1,55 @@ + + + + + + $title$ | olang + + + +
+

∅lang | The zero programming language.

+ +
+
+

$title$

+ + $body$ +
+ + + -- 2.34.1