Comments (4)
I think that swift-docc-render
should be responsible for the sitemap, as it's a web artifact, and docc itself just generates the inputs for it, right?
from swift-docc.
@natikgadzhi && @game-swoosh : Definitely, this is for the renderer.
from swift-docc.
Does this exist and if not, is it something that will be added?
This is not something that exists today.
I think a sitemap could potentially be a useful addition, but there are a couple of interesting quirks that may make it difficult to implement in the renderer itself:
- while the
.doccarchive
artifact produced by DocC can be hosted as a standalone website, it can also be integrated into an existing website, so there could be some conflict with any sitemap generated for the docs and an existing website that it is being integrated into on the hosting side (probably not the common case though, so maybe not a big issue) - DocC-Render purposefully doesn't have any build process so that a single prebuilt version of it can be shared with n number of built documentation artifacts. This means that you don't need to have node installed (etc) on your system or as part of the doc compiler to actually build your documentation catalog, which is nice, however it means that DocC-Render doesn't really have any logic that can run as part of generating the website artifact, which would be needed to create something like a sitemap tailored to an individual documentation catalog
- I think absolute URLs are usually expected in a sitemap and DocC-Render doesn't necessarily know where it's going to be hosted (could be multiple places even), so there would also need to be some build logic to configure the endpoint where the content will actually be hosted
If someone were to look into supporting this as a new feature/enhancement, I imagine that it may be much easier to implement in DocC itself—the logic used to generate the RenderIndex JSON file (which powers the sidebar navigation) would likely be very similar and maybe even tweaked to also generate a sitemap, since the data would be pretty similar.
from swift-docc.
@mportiz08 Sounds good. I'll transfer this issue back to DocC.
from swift-docc.
Related Issues (20)
- Typealiased type are not reflected properly in the documentation HOT 4
- Reenable DefaultDiagnosticConsoleFormatter HOT 1
- Crash when building locally HOT 4
- Duplicated diagnostic causing crash on DefaultDiagnosticConsoleFormatter HOT 8
- Overly strict warning when curating a module under a technology root HOT 19
- Line numbers in code listings HOT 3
- The wrong role is assigned to the technology-root node in article-only catalogs
- Any way to merge the index.json for multiple framework hosting on single Static site ? HOT 8
- Provide `@Embed` directive as an equivalent of HTML <embed/> or <iframe/>
- Swift-DocC should display C++ and Objective-C++ as their own source languages
- source link line number mismatch HOT 2
- Support svg images in Xcode inline documentation HOT 2
- Pass "link summaries" instead of "resolved information" in external documentation source responses
- Can't document - -= / /= operators HOT 8
- DocC generates inconsistent output for global Objective-C functions that are renamed to be associated with a type in Swift HOT 2
- Error when publishing to GitHub Pages HOT 6
- Linkable glossary
- Document Objective-C extensions with DocC HOT 2
- Xcode "Build documentation" not working with Swift Macro package in project HOT 5
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from swift-docc.