TechDocs - Documentation as catalog entities
exploring
Dudi Elhadad
Currently, you can ingest markdown documents into Port by creating markdown properties. Each document will be displayed in Port as a tab on the specific entity page.
We would like to add the ability to create a "documentation tree" for each entity, allowing you to create a full wiki inside your developer portal.
Similar to the singular markdown documents, the documents in the "documentation tree" will be searchable via the global search.
Photo Viewer
View photos in a modal
K
Kristoffer Smedlund
Some issues with this ive found after setting it up:
deal breaker - cannot link to a specific docs page neither copy the url to a specific page - our docs are meant to be shared and linked to people that are looking for them and not having URLs to specific pages just wont fly.
No index page rendered, cant find a option to set an index page - should pref. render the index.md if one exists, or give me an option to set the initial index page.
Can not find a way to order things in the sidebar.
All folders expanded at visit - a bit cluttered and hard to navigate, would prefer an option or that folders are closed on initial visit.
Naama Ben Oliel Ronen
We've been making progress on this, we just released a new guide on how to bring a full TechDocs experience into Port: Manage and surface technical documentation in Port https://docs.port.io/guides/all/manage-and-surface-technical-docs.
The guide includes ingesting markdown files as native catalog entities, a folder-based navigation plugin scoped to service/repo pages, global search + Port AI support, and works with GitHub, GitLab, etc. We're also sharing a reference TechDocs plugin with the community, so you can use it as-is, customize it, or build your own on top of Port's plugins framework.
Give it a try and let us know how it goes.
Photo Viewer
View photos in a modal
K
Kristoffer Smedlund
Naama Ben Oliel Ronen I gave some feedback above in its own post!
L
Lucas Carneiro Fraga
Hi Naama Ben Oliel Ronen, thanks for moving this suggestion to Exploring step!
I'd like to share a few points about this item that I didn't see covered in the suggestion's history — they might be useful context for you as a Product Manager at Port
It's widely recognized among developers that most companies, regardless of industry or size, end up producing very little technical documentation about their internal catalogs — whether due to competing priorities, time constraints, or simply culture. At the same time, companies that lean heavily on AI in their engineering workflows — or that genuinely prioritize documentation regardless of AI — tend to generate a significant amount of it directly inside their code repositories. That documentation becomes a valuable asset not just for software engineers, but for any team that occasionally needs to access those resources
There are several ways to make this content broadly available across teams, but one limitation I've always felt stands out in Port is the lack of native support for a documentation hierarchy within the product — which is exactly what this suggestion addresses
We're producing more Markdown today than ever before, and that trend isn't slowing down. It would be great to see the Port team prioritize this soon. The impact would be substantial — and it's no coincidence that this suggestion already has 100+ upvotes
Naama Ben Oliel Ronen
updated the status to
exploring
Chris Reilly
Naama Ben Oliel Ronen an easy win would be letting us hide the MD tabs. I have to rename them to " " since we have our own consolidated tab.
S
Sara Berg
We are really looking forward to this feature! Is there any updates?
K
Kristoffer Smedlund
It would be
super
to support the "documentation as code" repositories where we have a single repo with lots of documentation and only documentation too, we currently render those with mkdocs and publish to static websites, but would really love to have those inside port.P
Paulo Pereira
Are there any updates on this? Is there anything that can be shared?
We are evaluating Port, and this is a really important feature for us, so it would be good to have an update if possible.
Thanks!
S
Simon Beaulieu
Would this feature support mapping various markdown files using a glob pattern without need to have explicit properties to map them to ? An array of markdown files could also work.
Our use case would be to ingest all markdown files in a repository without explicitly knowing how many there will be beforehand. Since the number of results can vary dynamically, we cannot have one blueprint property of "markdown" type ready to accept each file.
R
Rory Logue
Any updates on this please?
We were told Q3 2024 and it's hard to run two catalogs at once without this feature being implemented.
R
Rory Logue
Are there any updates on this that can be shared?
Hila Kashai
Rory Logue: Hey there! Currently, we support ingesting documentation as markdown files into Port using our markdown type property (https://docs.getport.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/markdown). The ingested documentation is searchable using the global search.
We're in the early design stages for enabling you to ingest an entire documentation tree in markdown format from various sources. Once implemented, this documentation tree will also be indexed and fully searchable. We’ll keep you updated on progress as we move forward!
R
Rory Logue
Hila KashaiThank you, we're aware of the limitations of the current way of doing this and will need to wait for the documentation tree.
Ingesting hundreds of markdown documents in properties does not make it a searchable and useable documentation tree right now.
Load More
→