https://github.com/TrixTec/MarkHost

MarkHost is a fork/updated version of thejerf's markdir project
https://github.com/TrixTec/MarkHost

blackfriday-renderer dockerfile documentation documentation-tool go golang http-server

Last synced: 19 days ago
JSON representation

MarkHost is a fork/updated version of thejerf's markdir project

• Host: GitHub
• URL: https://github.com/TrixTec/MarkHost
• Owner: TrixTec
• License: mit
• Created: 2021-08-17T19:13:12.000Z (over 3 years ago)
• Default Branch: Markdir-v2.1
• Last Pushed: 2021-08-27T09:15:23.000Z (over 3 years ago)
• Last Synced: 2024-09-01T18:31:33.630Z (4 months ago)
• Topics: blackfriday-renderer, dockerfile, documentation, documentation-tool, go, golang, http-server
• Language: Go
• Homepage:
• Size: 18.7 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-golang-repositories - MarkHost

README

        
# About

MarkHost is a fork of *thejerf*'s Markdir project, that he has stoped working on...

[Link to the thejerf's markdir project](https://github.com/thejerf/markdir).

I've decied to work on inproveing the MarkDir project as a web based documentation system, that in the first few version will have no GUI but able to be interagted with [TieDB](https://tiedb.com/)

You have to build the program yourslef for the time being... but I might be able to change that on a later date.




# How to run it? (On a desktop)

After you have build and compiled the program **IN VERSION 1.16**, you can run the .exe or linux file. and the program sould start up in the background. The website will be hosted on your local host  [http://localhost:19000](http://localhost:19000). 


By default the path that the program looks in is the root directory, so anything outside of that it will not look for. If you wish to change it, look in the main.go and locate 'path' on L19. 


I've added an .exe for windows and an application for linux, so you dont have to compile the code!




# Running it in docker

I do not have a docker repo yet, but here's the code to run it in docker.

`docker run -p 19000:19000 -v /**your-path**:/docs markdir:latest /app/Markdir -path /docs -bind 0.0.0.0:19000`


 

The bind has to be 0.0.0.0 to set to local host, as linux dose not like 127.0.0.1