From 3eeac950d3e2fcc9204bd9ec0ec26764d63ac82a Mon Sep 17 00:00:00 2001 From: Iris Lightshard Date: Thu, 26 Sep 2024 19:32:04 -0600 Subject: [PATCH] update docs, add honk syndication --- .clang-format | 1 - LICENSE | 2 +- README.md | 10 +++++++--- build.sh | 6 ++++-- config.def.h | 31 ++++++++++++----------------- deploy.sh | 11 ++++++++--- main.c | 53 +++++++++++++++++++++++++++++++++++++------------- thumbnailer.sh | 20 +++++++++---------- tw.sh | 2 +- underbbs.sh | 33 +++++++++++++++++++++++++++++++ 10 files changed, 115 insertions(+), 54 deletions(-) create mode 100755 underbbs.sh diff --git a/.clang-format b/.clang-format index a699815..468a28a 100644 --- a/.clang-format +++ b/.clang-format @@ -13,7 +13,6 @@ IndentCaseLabels: true SpaceBeforeParens: ControlStatements AlignAfterOpenBracket: AlwaysBreak BinPackArguments: false -BinPackArguments: false PointerAlignment: Left BreakBeforeBraces: Attach SortIncludes: false diff --git a/LICENSE b/LICENSE index e8c00cc..d584a6d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright 2021 Derek Stevens +Copyright 2021 Iris Lightshard Copyright 2021 Devine Lu Linvega Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: diff --git a/README.md b/README.md index 87106a8..743ebb0 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ Eureka also parses a [twtxt](https://twtxt.readthedocs.io/en/latest/) file at `S 5. Create a new page, eg `inc/my_first_page.htm` (see the markup section below). 6. Edit your `inc/meta.nav.htm` again to reference your new page. 7. Run `./build.sh` again! You will be warned of any orphaned files. +8. Deploy with `./deploy.sh`. `--syndicate` will syndicate the latest twtxt to the honknet. +9. Revert changes and restore local with the live site with `./deploy.sh --resync`. ## build options @@ -34,6 +36,8 @@ Combined argument format like `./build.sh -rdt "twt stuff"` is not supported. Us If you run into issues with your markup crashing `eureka`, edit the `build.sh` file to uncomment the linux debug build line and comment the fast build; this will show you a stack trace of where you are running into buffer overflows, and give you a hint of where your markup is messed up. To see the individual file that has the error, also uncomment the line in `fpinject()` that prints the file names. +If you find a bug, let me know. + # markup There is a markup language which makes writing long blog posts, memex entries, etc easier by reducing the need for typing out HTML tags: @@ -128,14 +132,14 @@ The following macros are available in `config.h` to customize to your liking. - **NAME**: the title of the site - **DOMAIN**: currently unused - **LOGO_HTML**: HTML to put in the header h1 verbatim - - **ABOUT_HTML**: HTML content for the front page, placed between `
` and `