WIP: custom wiki in golang that utilizes git and serves pages with html, markdown, and css support https://tcp.wiki
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
legitnull 62f1a366c5
updated readme
2 months ago
assets updated readme 2 months ago
src added version tracking 2 months ago
.gitignore added better server handling and branch support 2 months ago
README.md updated readme 2 months ago
dev.sh added better server handling and branch support 2 months ago
go.mod added wip comments and breaking changes 2 months ago
go.sum added wip comments and breaking changes 2 months ago

README.md

H0wdy!!!

feel free to commit, leave suggestions/ideas, issues, or really anything <3

What is TCP.WIKI ?

https://tcp.ac/i/IFAZE

Project Goals

secure and verifiable wiki for projects, code, courses, documents, articles, tutorials, and more

Setup

For a normal user you can follow this process:

First clone the repo:

git clone https://git.tcp.direct/S4D/tcp-wiki.git

Then you have to cd into the repo's folder and run/compile:

cd tcp-wiki/src
go run .

Then you goto your browser and visit: http://127.0.0.1:8080/

For a develeper setup you can follow this process:

First clone the repo:

git clone ssh://git@git.tcp.direct:2222/S4D/tcp-wiki.git

Then cd and run dev.sh

cd tcp-wiki
bash dev.sh

Then you just have to execute this to run the server:

cd src && go run .

Then you goto your browser and visit: http://127.0.0.1:8080/

This method just adds in some handy symlinks for development purposes

Want to use with your own repo?

All you have to do is modify the following lines in the src/main.go file:

const repoURL = "https://git.tcp.direct/S4D/tcp-wiki.git"

Change https://git.tcp.direct/S4D/tcp-wiki.git to your repo link, and:

const repoBRANCH = "main"

change main to your specific repo's branch and you should be good to go!

TODO

  • MANY FUCKING THINGS
  • Webhook support for auto pull on push/update of the git repo
  • Git Branch support
  • add a star/upvote/like feature for pages
  • edit/version tracker
    • Author
    • last edited
    • last editor/commit [?] maybe working
    • PGP Signed & Verification
  • pgp signed intergration
  • comments using bitcask - generated in comments.db/
    • verification - no login pgp
    • captcha
    • sub rating system
    • sort by date etc
    • reply to replies
    • set security controls per page
    • auto refresh on post
  • dynamically generated links for all avaiable pages
    • sitemap
    • anti robot shit here
    • acual working pages!?
  • post quantum intergration and verification
  • BUILD UP THAT MARKDOWN SUPPORT
  • fix whatever i did to fuck up design/layout/css???