WikiTraccs for Markdown
With an authoritative Markdown repository, you break free from third-party constraints and their ongoing costs and changes, keeping complete control over your documentation.
If you have any of the following goals, this topic is for you:
- CUT COSTS—reduce licensing costs for third-party services like Atlassian Confluence
- CUT COMPLEXITY—reduce the number of in-house CMS deployments for documentation and knowledge management
- BE INTEROPERABLE—facilitate data exchange, e.g. with translation service
- BE FLEXIBLE—swap tools and third-party services used to maintain and publish documentation and knowledge with reduced effort
- BE AI-READY—maintain documentation in a format that AI can natively understand
WikiTraccs for Markdown is your tool of choice to publish Markdown files to SharePoint Online and to make them accessible for broader audiences.
Strategy Shift to Text Files and Markdown
What is Markdown?
Markdown is a simple text format that uses symbols (like # or *) to make text look nicely formatted. It’s an easy way to add headings, bold text, and links without using complicated code.Learn more about the shift to text-based documentation in the Strategy Shift to Text Files and Markdown article.
Learn more about what’s possible with text files in the Markdown-Based Repository article.
And finally, join the waitlist for WikiTraccs for Markdown to start publishing to SharePoint Online.
This topic is part of WikiTraccs for Markdown and work in progress.
Join the waitlist and start publishing Markdown to SharePoint soon
Markdown to SharePoint Samples
WikiTraccs for Markdown creates SharePoint pages from your Markdown files:
%%{ init: { 'theme': 'neutral', 'architecture': { 'iconSize': 80 } } }%% architecture-beta group markdownrepo(fluent:markdown-20-regular)[Markdown Repository] service markdown1(fluent:cube-tree-20-regular)[Files and Folders] in markdownrepo group wikitraccs(fluent:settings-cog-multiple-20-regular)[Publishing] service markdown2(fluent:cube-tree-20-regular)[Local Copy] in wikitraccs service wikitraccsapp(fluent:app-generic-20-regular)[WikiTraccs for Markdown] in wikitraccs wikitraccsapp:L --> R:markdown2 markdown1:R -- L:markdown2 group thirdparties(mdi:microsoft-sharepoint)[Services] service sharepoint(mdi:microsoft-sharepoint)[SharePoint Online] in thirdparties wikitraccsapp:R --> L:sharepoint
Sample 1
Here’s an excerpt of the Markdown specification CommonMark, rebuilt as Markdown file, provisioned as SharePoint page:
And here’s the source Markdown file for above page:
+++
id = "1"
+++
# CommonMark
**A strongly defined, highly compatible specification of Markdown.**
## What is Markdown?
It’s a plain text format for writing structured documents.
### Learn Markdown in 60 Seconds
**Markdown** is a simple way to format text that looks great on any device. It doesn’t do anything fancy like change the font size, color, or type — just the essentials, using keyboard symbols you already know.
Use _italic_ and **bold** to format text. [Links](https://www.wikitransformationproject.com) are supported, and so are **images**. Here's a small one:
![Image alt text](https://www.wikitransformationproject.com/assets/logo-32x32.png)
Use **unordered lists**:
* List
* List
* List
And **ordered lists**:
1. One
2. Two
3. Three
Or **tables**:
|Column 1|Column 2|
|--------|--------|
|Val 1 |Val 2 |
`Code can be written inline.`
For more code you can use code blocks:
```
<html>
<body>
</body>
</html>
```
## Want to experiment with Markdown?
Try the [10 minute interactive tutorial](https://commonmark.org/help/tutorial/) on the CommonMark web site.
## Need more detail?
Refer to [the official CommonMark spec](https://spec.commonmark.org/).
Sample 2
Here’s an excerpt from Microsoft’s Teams Toolkit documentation, rebuilt as Markdown file, provisioned as SharePoint page:
Here’s the Markdown source for above SharePoint page:
+++
id = "2"
+++
# Microsoft Teams Toolkit Overview
Teams Toolkit makes it simple to get started with app development for Microsoft Teams using Microsoft Visual Studio Code.
* Start with a project template for common custom app built for your org (LOB app) scenarios or from a sample.
* Save setup time with automated app registration and configuration.
* Run and debug to Teams directly from familiar tools.
* Smart defaults for hosting in Azure using infrastructure-as-code and Bicep.
* Create unique configurations like dev, test, and prod using the environment features.
_Note: Before you get started, we strongly recommend that you visit [Teams Toolkit v5 Guide](https://aka.ms/teamsfx-v5.0-guide) to learn key features, such as life cycles and actions._
![Illustration shows the User Journey of the Teams Toolkit.](teams-toolkit-user-journey2.png)
## Available for Visual Studio Code
Teams Toolkit is available for free for Visual Studio Code. For more information about installation and set up, see [Install Teams Toolkit](https://learn.microsoft.com/en-us/microsoftteams/platform/toolkit/install-teams-toolkit).
|Teams Toolkit| Visual Studio Code |
|-------------|--------------------|
|Installation | Available in the Visual Studio Code Marketplace
|Build with | JavaScript, TypeScript, React, SPFx
## Features
...
Further Documentation
Have a look at the (evolving) documentation on our way to a good Markdown-based knowledge repository: