API.md

Home.md

Sample Post.md

content

# Markbase

[Markbase](https://markbase.xyz) is a one click publish platform that lets you automatically sync and publish local markdown content to unlimited hosted domains

You can view more interactive API Documentation with Postman [here](https://documenter.getpostman.com/view/25606808/2s935ivSNR)

# 📁 Collection: Project

## `ListProjects`

List all projects for a user

````json
    "projects": [
        {
            "id": String,
            "slug": String,
            "name": String,
            "folderToShare": String,
            "publishedUrl": String,
            "repositoryUrl": String,
            "customCss": String,
            "customHeadJs": String,
            "customBodyJs": String,
            "public": Boolean,
            "metadata": {
                "id": String,
                "createdAt": String,
                "updatedAt": String"
            }
        }
    ]

````

### Method: GET

 > 
 > ````
 > https://api.markbase.xyz/projects/user
 > ````

## `CreateProject`

Create new project for a user

### Method: POST

 > 
 > ````
 > https://api.markbase.xyz/projects/user
 > ````

### Body formdata

|Param|value|Type|
|-----|-----|----|
|slug|String|text|
|name|String|text|
|folderToShare|String|text|
|zipFile|Buffer|text|

## `CustomCSS`

Apply custom css for a project

### Method: POST

 > 
 > ````
 > https://api.markbase.xyz/projects/user/custom-css
 > ````

### Body formdata

|Param|value|Type|
|-----|-----|----|
|slug|String|undefined|
|customCSS|String|undefined|

## `CustomHeadJS`

Apply custom JS to the head for a project

### Method: POST

 > 
 > ````
 > https://api.markbase.xyz/custom-head-js
 > ````

### Body formdata

|Param|value|Type|
|-----|-----|----|
|slug|String|undefined|
|customHeadJS|String|undefined|

## `CustomBodyJS`

Apply custom JS to the body for a project

### Method: POST

 > 
 > ````
 > https://api.markbase.xyz/projects/user/custom-body-js
 > ````

### Body formdata

|Param|value|Type|
|-----|-----|----|
|slug|String|undefined|
|customBodyJS|String|undefined|

## `CustomDomain`

Apply a custom domain for a project

### Method: POST

 > 
 > ````
 > https://api.markbase.xyz/projects/user/custom-domain
 > ````

### Body formdata

|Param|value|Type|
|-----|-----|----|
|slug|String|undefined|
|customDomain|String|undefined|

## `ProjectByID`

Get a project by ID

````json
    "projects": [
        {
            "id": String,
            "slug": String,
            "name": String,
            "folderToShare": String,
            "publishedUrl": String,
            "repositoryUrl": String,
            "customCss": String,
            "customHeadJs": String,
            "customBodyJs": String,
            "public": Boolean,
            "metadata": {
                "id": String,
                "createdAt": String,
                "updatedAt": String"
            }
        }
    ]

````

### Method: GET

 > 
 > ````
 > https://api.markbase.xyz/projects/id/:projectId
 > ````

## `UpdateProjectById`

Update a project by ID

### Method: PUT

 > 
 > ````
 > https://api.markbase.xyz/projects/id/:projectId
 > ````

## `DeleteProjectById`

Delete a project by ID

### Method: DELETE

 > 
 > ````
 > https://api.markbase.xyz/projects/id/:projectId
 > ````

## `ProjectBySlug`

Get project by Slug

### Method: GET

 > 
 > ````
 > https://api.markbase.xyz//projects/slug/:projectSlug
 > ````

## `SyncProject`

Sync a project's deployment with content and styles

### Method: POST

 > 
 > ````
 > https://api.markbase.xyz/projects/user/sync
 > ````

### Body formdata

|Param|value|Type|
|-----|-----|----|
|slug|String|undefined|
|file|Buffer|undefined|

# 📁 Collection: Stripe

## `Checkout`

Proceed to checkout via stripe

### Method: GET

 > 
 > ````
 > https://api.markbase.xyz/stripe/checkout?priceId=String
 > ````

### Query Params

|Param|value|
|-----|-----|
|priceId|String|

## `Subscriptions`

Get active subscriptions for user

### Method: GET

 > 
 > ````
 > https://api.markbase.xyz/stripe/subscriptions
 > ````

## `SubscriptionById`

Get subscription by ID

### Method: GET

 > 
 > ````
 > https://api.markbase.xyz/stripe/subscriptions/:subscriptionId
 > ````

## `Session`

Get Stripe checkout session

### Method: GET

 > 
 > ````
 > https://api.markbase.xyz/stripe/portal
 > ````

# 📁 Collection: User

## `CreateUser`

Create a new User if it does not exist

### Method: POST

 > 
 > ````
 > https://api.markbase.xyz/user
 > ````

## `UserInfo`

Get info for a user

### Method: GET

 > 
 > ````
 > https://api.markbase.xyz/user/me
 > ````

## `UserFeedback`

Publish user feedback

### Method: POST

 > 
 > ````
 > https://api.markbase.xyz/user/feedback
 > ````

## `UserOnboarding`

Send user a onboarding email

### Method: POST

 > 
 > ````
 > https://api.markbase.xyz/user/onboarding
 > ````

# 📁 Collection: Token

## `TokenObsidian`

Get Obsidian Token

### Method: GET

 > 
 > ````
 > https://api.markbase.xyz/token/obsidian
 > ````

## `TokenObsidianVerify`

Verify obsidian token

### Method: GET

 > 
 > ````
 > https://api.markbase.xyz/token/obsidian/verify
 > ````



# One Click Publish

## Sync local files to your own online blog/digital garden

![Demo GIF](https://s8.gifyu.com/images/Animationc83524d2723e95c3.gif)

There's no need to learn about GitHub, CI/CD pipelines or online hosting providers.

In three simple steps, you can **set up an online blog/digital garden** of your notes (like this website):

1. Sign up for Markbase *(and get your unique token)*
1. Download the *[Markbase for Obsidian](https://obsidian.md/plugins?id=obsidian-markbase)* plugin
1. Create a project and choose the folder you want to upload online

## 💡 Features

* **Fast** load times
  * Fast internal links (client-side routing)
  * Statically generated pages
* Changes go **live in minutes!** (Just change a file in Obsidian and press the Sync button)
* Rapid, **full-text search** (seriously, try it!)
* View **backlinks** and a **local graph** of your notes
* **Optimized for SEO**
  * Statically generated
  * Auto-filled metadata for every page
  * Slugs based on your file names
  * Automatic sitemap generation
* **Mobile/tablet optimized**
* **Hover links** (try [this one](Sample%20Post.md))
* **Dark/light mode**
* **Table of Contents** and section/heading links

To see upcoming features and vote on ones you want most, check out the [public roadmap](https://trello.com/b/qYaGuz0i/markbase-product-roadmap)!

## 📚 API

Currently Markbase only supports Obsidian, but we have a public API that you can use to build your own integrations while we work on creating custom ones for other networked thought and knowledge management platforms. View the documentation here [API documentation](API.md). 

## FAQ

If you have any questions not on this list, feel free to email [hello@markbase.xyz](mailto:hello@markbase.xyz)

### What makes this better than all the other free Obsidian Publish alternatives out there?

Markbase is completely **non-technical** - you don't need to learn about GitHub, do any special configuration steps in Notepad or learn about hosting providers like Netlify. 

Literally all you have to do is create an account, install the plugin, choose a folder of Markdown files and that's it!

There are downsides - Markbase isn't open-source or as customizable as other GitHub-based alternatives. It's great if you're after an easy, low-hassle solution otherwise those other solutions are still out there!

### I want {this feature} - can you add it?

You can suggest and vote on features in the [public roadmap](https://trello.com/b/qYaGuz0i/markbase-product-roadmap)! I read all of them and prioritize them according to votes. Thanks for your feedback - it helps heaps to know what the community wants in the early days.

### {Something} doesn't work - what do I do?

Markbase is definitely still in early development so there's bound to be bugs that surface during your use.

If you find one, submit a ticket in the [help center](https://markbase.tawk.help/), use the live chat in the app dashboard or email [hello@markbase.xyz](mailto:hello@markbase.xyz).

## Other pages

[Blog](./Sample%20Post.md)

[Help Center](https://markbase.tawk.help/)

[Public Feedback/Roadmap](https://trello.com/b/qYaGuz0i/markbase-product-roadmap)

# Acknowledgements

Thanks to [Jacky Zhao's Quartz project](https://quartz.jzhao.xyz/) for design inspiration on notable elements (including hover links, graph and backlinks design). Highly recommend checking it out if you're interested in an open-source, potentially self-hosted solution.


Home

# Sample Post

Here's what a bunch of Markdown looks like on Markbase!

## Highlights

You can highlight ==important parts of your text== using two equals signs followed by text to highlight and then closed with two equals signs again.

## Links

External links (to sites outside this domain) look like [this](https://tressel.xyz)

Internal links (to your own Markdown files) **hover** and look like [this](../Home.md).

## Quotes

 > 
 > For the first time in history, we have instantaneous access to the world’s knowledge. There has never been a better time to learn, to contribute, and to improve ourselves. Yet, rather than feeling empowered, we are often left feeling overwhelmed by this constant influx of information.

 > 
 > They can be split into
 > Multiple lines
 > Too

## Callouts

 > 
 > \[!NOTE\] 
 > A simple note callout

 > 
 > \[!SUMMARY\]
 > A simple summary/abstract/tldr callout

 > 
 > \[!INFO\]
 > A simple info/todo callout

 > 
 > \[!TIP\]
 > A simple tip/hint/important callout

 > 
 > \[!SUCCESS\]
 > A simple success/check/done callout

 > 
 > \[!QUESTION\]
 > A simple question/help/faq callout

 > 
 > \[!WARNING\]
 > A simple warning/caution/attention callout

 > 
 > \[!FAILURE\]
 > A simple failure/fail/missing callout

 > 
 > \[!DANGER\]
 > A simple danger/error callout

 > 
 > \[!BUG\]
 > A simple bug callout

 > 
 > \[!EXAMPLE\]
 > A simple example callout

 > 
 > \[!QUOTE\]
 > A simple quote/cite callout

## Tables

|Tables|Are|Cool|
|------|:-:|---:|
|This column|is left-aligned|$1600|
|This one|is centered|$12|
|And this one|is right-aligned|$1|

## Code

````js
// Here's what JavaScript code looks like
const sampleElement = "secondBrain";
const sampleObject = {
    fill: "this",
    in: true,
    the: null,
    blanks: 123123
};
````


Tables	Are	Cool
This column	is left-aligned	$1600
This one	is centered	$12
And this one	is right-aligned	$1