Markdown

Markdown

Application and Data / Languages & Frameworks / Languages
Needs advice
on
GatsbyGatsbyHexoHexo
and
WordPressWordPress

I have been building a website with Gatsby (for a small group of volunteers). I track it in GitHub and push it to Amazon S3.

I am satisfied with it as a single user; however, I would like to get non-technical teammates to be able to post Markdown blog posts. I tried to teach them to add mdx files, git push, gastby build, and publish with gatsby-plugin-s3, but I am getting a fair amount of resistance :).

So I wonder if there are tools, preferably using Node.js, that allow multi-user blog authors a la wordpress, i.e. with an interface for non technical bloggers, but producing static/pre-rendered web pages.

(PS: I am considering having a node/express.js server where they could upload their mdx file and the server would re-build push and publish for them, without having them install anything, but I'd like to know if something already exists before jumping into this endeavor)

READ MORE
6 upvotes47.3K views
Replies (1)
Recommends
on
Gatsby
Netlify CMS

If you're after Markdown I would look at https://www.netlifycms.org. I've used it on several projects to allow clients to use Markdown to publish and it integrates really well with Gatsby. You can create your own content structures using it then implement them into your templates. These are all the widgets you can use: https://www.netlifycms.org/docs/widgets/

This keeps it strictly static file driven with no database or need for express etc.

READ MORE
9 upvotes1 comment18.2K views
Arnaud Amzallag
Arnaud Amzallag
March 31st 2022 at 6:29PM

Thank you, I was skeptical at first, but now that I read more about it, that is a great answer! Before you answered I started to go the route of ghost.js and see how the gatsby build could source from my ghost server, but that would be an endeavor. netlifyCMS seems to acheive what I wanted much more directly. Will continue to learn about it. Thank you!

Reply
Needs advice
on
ConfluenceConfluence
and
GitHub PagesGitHub Pages

Confluence is pretty limited in terms of creating rich content, so I'm thinking about having the team put some effort into switching over to a Markdown-based system like GitHub Pages. Do you know of any pros and cons of GitHub pages for internal content of an organization vs Confluence?

READ MORE
5 upvotes41.9K views
Replies (1)
Backend Engineer at DAZN

I would consider using GitHub pages for internal static sites / Blog posts / API documentations.

If you have other documents with a lot of pictures (like architecture diagram, data flow diagram etc), I will still prefer confluence to GitHub pages because managing many images thru Github pages are a hassle. Its much easier with confluence-draw.io integration.

READ MORE
2 upvotes1 comment791 views
Hiren Shah
Hiren Shah
January 21st 2022 at 4:38PM

Can you explain why GitHup pages is better for internal static sites/ Blog Posts / API docs instead of Confluence? Much appreciated

Reply
Needs advice
on
Next.jsNext.js
and
Nuxt.jsNuxt.js

I want to build a documentation tool - functionally equivalent to MkDocs. The initial choice ought to be VuePress - but I know of at least one respectable developer who started with VuePress and switched to Nuxt.js. A rich set of "themes" is a plus and all documents ought to be in Markdown.

Any opinions?

READ MORE
12 upvotes336.8K views
Replies (2)
founder at Webcompose.ca
Needs advice
on
MarkdownMarkdown
and
PHPPHP

I am a newbie to StackShare and the GitHub community. I want to understand how to use an include statement to get a collection of Markdown files to create a book. I have been told that there are a number of useful tools. My problem is that npm and Node.js are also very new to me. Any suggestions on how to get my md chapters into a printable document would be helpful.

READ MORE
6 upvotes74.9K views
Senior Fullstack Developer at QUANTUSflow Software GmbH

Our whole DevOps stack consists of the following tools:

  • GitHub (incl. GitHub Pages/Markdown for Documentation, GettingStarted and HowTo's) for collaborative review and code management tool
  • Respectively Git as revision control system
  • SourceTree as Git GUI
  • Visual Studio Code as IDE
  • CircleCI for continuous integration (automatize development process)
  • Prettier / TSLint / ESLint as code linter
  • SonarQube as quality gate
  • Docker as container management (incl. Docker Compose for multi-container application management)
  • VirtualBox for operating system simulation tests
  • Kubernetes as cluster management for docker containers
  • Heroku for deploying in test environments
  • nginx as web server (preferably used as facade server in production environment)
  • SSLMate (using OpenSSL) for certificate management
  • Amazon EC2 (incl. Amazon S3) for deploying in stage (production-like) and production environments
  • PostgreSQL as preferred database system
  • Redis as preferred in-memory database/store (great for caching)

The main reason we have chosen Kubernetes over Docker Swarm is related to the following artifacts:

  • Key features: Easy and flexible installation, Clear dashboard, Great scaling operations, Monitoring is an integral part, Great load balancing concepts, Monitors the condition and ensures compensation in the event of failure.
  • Applications: An application can be deployed using a combination of pods, deployments, and services (or micro-services).
  • Functionality: Kubernetes as a complex installation and setup process, but it not as limited as Docker Swarm.
  • Monitoring: It supports multiple versions of logging and monitoring when the services are deployed within the cluster (Elasticsearch/Kibana (ELK), Heapster/Grafana, Sysdig cloud integration).
  • Scalability: All-in-one framework for distributed systems.
  • Other Benefits: Kubernetes is backed by the Cloud Native Computing Foundation (CNCF), huge community among container orchestration tools, it is an open source and modular tool that works with any OS.
READ MORE
30 upvotes2 comments10.6M views
Larry Gryziak
Larry Gryziak
April 30th 2020 at 6:34PM

So why is your deployment different for your (Heroku) test/dev and your stage/production?

Reply
Simon Reymann
Simon Reymann
May 1st 2020 at 10:32AM

When it comes to testing our web app we do not demand great computational resources and need a very simple, convenient and fast PaaS solution for deploying the app to our testers. In production though, the demand of great computational resources can rise very fast. With Amazon we are able to control that in better way.

Reply