Implement custom markdown dialect - Where to start?

cknoll · July 10, 2016, 6:48am

I am playing around with hugo as a desktop wiki backend. Therefore I would like to add some custom syntax elements to markdown like:

[page2] as shorthand instead of [page2]({{< relref "page2.md" >}}) or

todo lists like in github:

I guess, this needs some additional code. My question is, where to place this new code, i.e. where is the current markdown rendering implemented? And how modular is this rendering? (Maybe there is some documentation on these internals but I did not find it.)

Thanks,
Carsten.

bep · July 10, 2016, 9:14am

github.com

gohugoio/hugo/blob/master/helpers/content.go

// Copyright 2015 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package helpers implements general utility functions that work with
// and on content.  The helper functions defined here lay down the
// foundation of how Hugo works with files and filepaths, and perform
// string operations on content.
package helpers

import (

This file has been truncated. show original

Topic		Replies	Views
Custom markdown extension support	3	846	September 30, 2016
Preprocessor / additions to markdown's syntax support	5	3535	March 7, 2018
Can I customized HTML produced from Markdown? support	3	485	May 16, 2020
Markdown Render Hooks - GitHub and Hugo compatible links support	13	2460	February 28, 2020
How I Extended Markdown for Hugo tips & tricks	7	10264	May 12, 2020

Implement custom markdown dialect - Where to start?

Related topics