https://github.com/symkat/MarkdownSite

Skip to content
 
Sign up

  * Product
      + Features
      + Mobile
      + Actions
      + Codespaces
      + Packages
      + Security
      + Code review
      + Issues
      + Integrations
      + GitHub Sponsors
      + Customer stories
  * Team
  * Enterprise
  * Explore
      + Explore GitHub
      + Learn and contribute
      + Topics
      + Collections
      + Trending
      + Learning Lab
      + Open source guides
      + Connect with others
      + The ReadME Project
      + Events
      + Community forum
      + GitHub Education
      + GitHub Stars program
  * Marketplace
  * Pricing
      + Plans
      + Compare plans
      + Contact Sales
      + Education

[                    ] 

  *  
    #
    In this repository All GitHub |
    Jump to |

  * No suggested jump to results

  *  
    #
    In this repository All GitHub |
    Jump to |
  *  
    #
    In this user All GitHub |
    Jump to |
  *  
    #
    In this repository All GitHub |
    Jump to |

Sign in
Sign up
{{ message }}

symkat / MarkdownSite Public

  * 
  * Notifications
  * Fork 0
  * Star 23

Create a website from a git repository in one click

markdownsite.com
23 stars 0 forks
Star
Notifications

  * Code
  * Issues 0
  * Pull requests 0
  * Actions
  * Projects 0
  * Wiki
  * Security
  * Insights

More

  * Code
  * Issues
  * Pull requests
  * Actions
  * Projects
  * Wiki
  * Security
  * Insights

This commit does not belong to any branch on this repository, and may
belong to a fork outside of the repository.
master
Switch branches/tags
[                    ]
Branches Tags
Could not load branches
Nothing to show
{{ refName }} default View all branches
Could not load tags
Nothing to show
{{ refName }} default
View all tags
1 branch 0 tags
Code

Latest commit

@symkat
symkat Add plausible back
...
e116f91 Mar 14, 2022
Add plausible back
e116f91

Git stats

  * 82 commits

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
CGI
Handle markdown files without metadata.
Feb 13, 2022
Manager-DB
DB Regen
Feb 20, 2022
Manager
Add plausible back
Mar 14, 2022
devops
Update docs.
Mar 14, 2022
FUNDING.yml
Update FUNDING.yml
Mar 14, 2022
README.md
Update readme.
Mar 14, 2022
View code
What Is MarkdownSite? How do I use MarkdownSite? What are the
directories here? Visual View Of MarkdownSite Thanks For Looking!

README.md

MarkdownSite Homepage

This is the codebase for MarkdownSite, an open-source hosting
platform for static sites and markdown files.

 What Is MarkdownSite?

MarkdownSite is a platform for hosting websites.

People who want their websites hosted enter a git url for their
repository.

MarkdownSite downloads their repo and turns anything in public/ into
a static website hosted at a random subdomain.

Anything MarkdownSite finds in site/ that is an .md file will be
rendered as HTML.

Once MarkdownSite downloads and builds the website, it is sent to one
or more webservers and accepts traffic from the Internet.

 How do I use MarkdownSite?

You can use MarkdownSite to host a website.

You can build your own version of MarkdownSite to host as many
websites as you want on your own infrastructure. See the devops/
directory for instructions on getting an instance running.

 What are the directories here?

CGI contains the Markdown::CGI program. This renders markdown files
to HTML, and is installed on the webservers.

Manager-DB contains the markdownsite database schema, and the code
for MarkdownSite::Manager::DB, a DBIx::Class interface to the
database.

Manager is MarkdownSite::Manager, a mojolicious-based webapp for
submitting the repository and viewing build status. This contains a
Minion worker that handles building and deploying the websites.

devops/setup contains an ansible code base to install servers by
their server type, and documentation explaining it.

devops/config contains an ansible code base that can be maintained
and extended -- it is configuration management for an active
MarkdownSite instance.

devops/ contains additional graphs and network diagrams,

 Visual View Of MarkdownSite

This is a birds-eye view of a three-node setup, without insight
server.

flowchart TB
    subgraph one[Panel Node]
    a1[PostgresSQL]
    a2[MarkdownSite::Manager Daemon]
    a3[Nginx]
    a1 <-- MarkdownSite::Manager::DB / Minion--> a2
    a3 -- Hypnotoad PSGI --> a2

    end
    subgraph two[Build Node]
    b1[Clone & Build Website]
    b2[MarkdownSite::Manager Worker]
    b2 <-- PSQL Private IP --> a1
    end
    subgraph three[WebServer Node]
    c1[Lighttpd]
    c2[Static Files]
    c3[MarkdownSite::CGI]
    c1 <-- Static File Exists --> c2
    c1 <-- No File Exists--> c3
    c3 -- Generate & Store HTML Page From Markdown--> c2
    end

    b1 -- Ansible SSH--> three
    q[Internet User] <-- View Hosted Website -->c1
    z[MarkdownSite User] <-- Submit Git Repo For Hosting -->a3

MarkdownSite has an additional server, insight, that does metrics and
graphs with Graphite, Grafana, and Collectd.

Grafana Graphs

 Thanks For Looking!

Thank you for taking the time to checkout this repository. I hope the
information here has been useful.

About

Create a website from a git repository in one click

markdownsite.com

Topics

infrastructure markdown website hosting static-site

Resources

Readme

Stars

23 stars

Watchers

1 watching

Forks

0 forks

Sponsor this project

 
Sponsor
Learn more about GitHub Sponsors

Languages

  * CSS 56.0%
  * Jinja 31.5%
  * Perl 12.1%
  * Shell 0.2%
  * JavaScript 0.1%
  * Lua 0.1%

  *  (c) 2022 GitHub, Inc.

  * Terms
  * Privacy
  * Security
  * Status
  * Docs
  * Contact GitHub
  * Pricing
  * API
  * Training
  * Blog
  * About

You can't perform that action at this time.
You signed in with another tab or window. Reload to refresh your
session. You signed out in another tab or window. Reload to refresh
your session.