Clean URLs using Custom URLs

fastn allows your to map documents to any URL you like, let’s take a look at why and how.


fastn by default creates the URL based on the file path of a document, eg / corresponds to index.ftd and /docs/ looks for both docs.ftd and docs/index.ftd.

This ties URLs with folder heirarchy.

SEO Angle

This can cause some issues with organisation, as SEO and clean URL people want URLs to not have meaningless information, like your folder heirarchy.

Short URLs

URLs are good, for example for, we have a processor called http processor and we often want to link to it using which is short and easily memorisable. But the document we store is in ftd-host/http.ftd based on our organisations guidelines.

Folder Organization

But you do not want to put all the documents on the top level, as without folder heirarchy it becomes hard to navigate.

document attribute in fastn.sitemap

fastn is configured using a file called FASTN.ftd, where you can define a sitemap of your site.

Normally your sitemap may look like this.
letting fastn guess the document based on url
-- fastn.sitemap:

- Home: /
- Docs: /docs/
Auto guess can be overriden using the document attribute:
using document to specify document location
-- fastn.sitemap:

- Home: /
- Docs: /docs/
  document: documentation.ftd
There you go, make all your URLs clean, and folders organised! Do checkout the dynamic URLs guide to learn how to make URLs dynamic.

Support fastn!

Enjoying fastn? Please consider giving us a star ⭐️ on GitHub to show your support!

Getting Help

Have a question or need help?

Visit our GitHub Q&A discussion to get answers and subscribe to it to stay tuned.

Join our Discord channel and share your thoughts, suggestion, question etc.

Connect with our community!

Found an issue?

If you find some issue, please visit our GitHub issues to tell us about it.

Join us

We welcome you to join our Discord community today.

We are trying to create the language for human beings and we do not believe it would be possible without your support. We would love to hear from you.
Copyright © 2023 -