stamd

Static Markdown Page Generator

git clone git://git.dimitrijedobrota.com/stamd.git

commit	19b2b8c73dfa62137dd776e15ff1aff0dc9ea06e
parent	b014ac73d73be5ae8a85f2ff3d43ff07134e6714
author	Dimitrije Dobrota <mail@dimitrijedobrota.com>
date	Thu, 27 Jun 2024 15:45:06 +0200

Update README.md * Remove github workflow

Diffstat:

D	.github/workflows/ci.yml	\|	---------------------------------------------------------------------------------
M	CMakeLists.txt	\|	+-
M	README.md	\|	++++++++++++++++++++++++++++++++++++++++++++++++----

3 files changed, 49 insertions(+), 191 deletions(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml

@@ -1,186 +0,0 @@

name: Continuous Integration

on:

push:

branches:

- master

pull_request:

branches:

- master

jobs:

lint:

runs-on: ubuntu-22.04

steps:

- uses: actions/checkout@v4

- uses: actions/setup-python@v5

with: { python-version: "3.12" }

- name: Install codespell

run: pip3 install codespell

- name: Lint

run: cmake -D FORMAT_COMMAND=clang-format-14 -P cmake/lint.cmake

- name: Spell check

if: always()

run: cmake -P cmake/spell.cmake

coverage:

needs: [lint]

runs-on: ubuntu-22.04

# To enable coverage, delete the last line from the conditional below and

# edit the "<name>" placeholder to your GitHub name.

# If you do not wish to use codecov, then simply delete this job from the

# workflow.

if: github.repository_owner == '<name>'

&& false

steps:

- uses: actions/checkout@v4

- name: Install LCov

run: sudo apt-get update -q

&& sudo apt-get install lcov -q -y

- name: Configure

run: cmake --preset=ci-coverage

- name: Build

run: cmake --build build/coverage -j 2

- name: Test

working-directory: build/coverage

run: ctest --output-on-failure --no-tests=error -j 2

- name: Process coverage info

run: cmake --build build/coverage -t coverage

- name: Submit to codecov.io

uses: codecov/codecov-action@v4

with:

file: build/coverage/coverage.info

token: ${{ secrets.CODECOV_TOKEN }}

sanitize:

needs: [lint]

runs-on: ubuntu-22.04

env: { CXX: clang++-14 }

steps:

- uses: actions/checkout@v4

- name: Configure

run: cmake --preset=ci-sanitize

- name: Build

run: cmake --build build/sanitize -j 2

- name: Test

working-directory: build/sanitize

env:

ASAN_OPTIONS: "strict_string_checks=1:\

detect_stack_use_after_return=1:\

check_initialization_order=1:\

strict_init_order=1:\

detect_leaks=1:\

halt_on_error=1"

UBSAN_OPTIONS: "print_stacktrace=1:\

halt_on_error=1"

run: ctest --output-on-failure --no-tests=error -j 2

test:

needs: [lint]

strategy:

matrix:

os: [macos-14, ubuntu-22.04, windows-2022]

runs-on: ${{ matrix.os }}

steps:

- uses: actions/checkout@v4

- name: Install static analyzers

if: matrix.os == 'ubuntu-22.04'

run: >-

sudo apt-get install clang-tidy-14 cppcheck -y -q

sudo update-alternatives --install

/usr/bin/clang-tidy clang-tidy

/usr/bin/clang-tidy-14 140

- name: Setup MultiToolTask

if: matrix.os == 'windows-2022'

run: |

Add-Content "$env:GITHUB_ENV" 'UseMultiToolTask=true'

Add-Content "$env:GITHUB_ENV" 'EnforceProcessCountAcrossBuilds=true'

- name: Configure

shell: pwsh

run: cmake "--preset=ci-$("${{ matrix.os }}".split("-")[0])"

- name: Build

run: cmake --build build --config Release -j 2

- name: Install

run: cmake --install build --config Release --prefix prefix

- name: Test

working-directory: build

run: ctest --output-on-failure --no-tests=error -C Release -j 2

docs:

# Deploy docs only when builds succeed

needs: [sanitize, test]

runs-on: ubuntu-22.04

# To enable, first you have to create an orphaned gh-pages branch:

# git switch --orphan gh-pages

# git commit --allow-empty -m "Initial commit"

# git push -u origin gh-pages

# Edit the <name> placeholder below to your GitHub name, so this action

# runs only in your repository and no one else's fork. After these, delete

# this comment and the last line in the conditional below.

# If you do not wish to use GitHub Pages for deploying documentation, then

# simply delete this job similarly to the coverage one.

if: github.ref == 'refs/heads/master'

&& github.event_name == 'push'

&& github.repository_owner == '<name>'

&& false

permissions:

contents: write

steps:

- uses: actions/checkout@v4

- uses: actions/setup-python@v5

with: { python-version: "3.12" }

- name: Install m.css dependencies

run: pip3 install jinja2 Pygments

- name: Install Doxygen

run: sudo apt-get update -q

&& sudo apt-get install doxygen -q -y

- name: Build docs

run: cmake "-DPROJECT_SOURCE_DIR=$PWD" "-DPROJECT_BINARY_DIR=$PWD/build"

-P cmake/docs-ci.cmake

- name: Deploy docs

uses: peaceiris/actions-gh-pages@v4

with:

github_token: ${{ secrets.GITHUB_TOKEN }}

publish_dir: build/docs/html

diff --git a/CMakeLists.txt b/CMakeLists.txt

@@ -4,7 +4,7 @@ include(cmake/prelude.cmake)

project(

stamd

VERSION 0.2.6

VERSION 0.2.7

DESCRIPTION "Static Markdown Page Generator"

HOMEPAGE_URL "https://git.dimitrijedobrota.com/stamd.git"

LANGUAGES CXX

diff --git a/README.md b/README.md

@@ -1,15 +1,59 @@

# stamd

This is the stamd project.

Static Markdown blogging platform that generates everything you need

# Building and installing

## Description

With this project you can seamlessly turn a collection of .md files into a

static webpage, with auto generated indexes for categories, rss and atom feeds,

sitemap.xml and robots.txt.

It's configured to make pages for my [personal website](https://dimitrijedobrota.com/),

but as generation code is self documenting , it can be easily adopted to fit

your needs, all you have to do is change write_header and write_footer methods

as you see fit.

As of now most of the heavy lifting is done by md4c library, until I find time

to develop sophisticated Markdown to HTML converter.

## Dependencies

* CMake 3.14 or latter

* Compiler with C++20 support (tested: clang 16.0.5, gcc 13.2.0)

* [Poafloc latest](https://github.com/DimitrijeDobrota/poafloc)

* [Hemplate latest](https://github.com/DimitrijeDobrota/hemplate)

* [md4c](https://github.com/mity/md4c)

## Building and installing

See the [BUILDING](BUILDING.md) document.

# Contributing

## Usage

> Please reference [cabin-deploy.sh](https://github.com/DimitrijeDobrota/cabin) for relevant usage example

## Version History

- 0.2

* C++ rewrite

* Improved stability

* Improve readability

* Generate sitemap.xml and robots.txt

- 0.1

* Quick and dirty proof of concept written in C

## Contributing

See the [CONTRIBUTING](CONTRIBUTING.md) document.

# Licensing

This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) document for details

This project is licensed under the MIT License

- see the [LICENSE](LICENSE.md) document for details