Host and automate your DocC documentation

RSS for tag

Discuss the WWDC21 session Host and automate your DocC documentation.

Posts under wwdc21-10236 tag

6 Posts

Post

Replies

Boosts

Views

Activity

Static Hosting Support using DocC
I'm able to create my documentation via Xcode-> Product -> Build Documentation and that creates MY_PROJ.docarchive. I can also create .docarchive using xcodebuild command Now I'm trying to convert/export my .docarchive to host it in static space so that I can host it on Github pages. I'm using https://github.com/apple/swift-docc to convert my docarchive using the following command, swift run docc process-archive transform-for-static-hosting <path/to/docarchive> --output-path <destination_path> I can see the files exported in output-path which I believe is the files that I need to deploy in static hosting space. But when I host the same files in my local server or Github pages, they are still blank. Not sure what's wrong here.
3
0
4.1k
Apr ’22
How to host multiple docarchives on a single http server?
I have a few different projects and a ton of tutorials I want to host on the same http server... is this possible? I watched the Host and automate your DocC documentation session, but it seemed to only work with those rules for one docarchive. I know someone filed feedback for prefixes (https://developer.apple.com/forums/thread/682276)... is this possible already? Thanks.
3
0
3.3k
Feb ’22
DocC documentation can't be rendered with Apache on CentOS 7
I downloaded the sample code project 'SlothCreator' from here then exported a SlothCreator.doccarchive file. I placed the SlothCreator.doccarchive in /var/www/html/. I use Apache web server on CentOS 7. My .htaccess file is as follows. # Enable custom routing. RewriteEngine On # Route documentation and tutorial pages. RewriteRule ^(documentation|tutorials)\/.*$ SlothCreator.doccarchive/index.html [L] # Route files and data for the documentation archive. RewriteRule ^(css|js|data|images|downloads|favicon\.ico|favicon\.svg|img|theme-settings\.json|videos)\/.$ SlothCreator.doccarchive/$0 [L] # If the file path doesn't exist in the website's root ... RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-d # ... route the request to that file path with the documentation archive. RewriteRule .* SlothCreator.doccarchive/$0 [L] I confirmed that the RewriteEngine works well. I try the following urls then see error message "An unknown error occurred." or "The page you’re looking for can’t be found." http://localhost/documentation/SlothCreator => "An unknown error occurred." http://localhost/SlothCreator.doccarchive/index.html => "The page you’re looking for can’t be found." Can I know what the problem is? Doesn't it work with CentOS?
4
0
2.3k
Dec ’21
Missing search field in hosted documentation
I found out docC is missing search field in hosted documentation, that is currently for example in documentation tool jazzy (https://pspdfkit.com/blog/2016/adding-live-search-to-jazzy/). This is useful feature that should have every documentation. I would consider it as one of the vital feature for every documentation. Could we expect this feature someday ? Thanks for answer.
2
0
1.1k
Sep ’21
DocC generated index.html inside .doccarchive showing blank page when opened in browser
Hi, I'm having trouble displaying DocC in the browser. I tried SlothCreator example project generated .doccarchive as well, but the result is the same. index.html once opened shows blank page on all the browsers - Safari, Chrome etc. Hopefully its possible to see how it will look like before hosting on the website. Regards, Milos
3
0
1.2k
Jul ’21
Static Hosting Support using DocC
I'm able to create my documentation via Xcode-> Product -> Build Documentation and that creates MY_PROJ.docarchive. I can also create .docarchive using xcodebuild command Now I'm trying to convert/export my .docarchive to host it in static space so that I can host it on Github pages. I'm using https://github.com/apple/swift-docc to convert my docarchive using the following command, swift run docc process-archive transform-for-static-hosting <path/to/docarchive> --output-path <destination_path> I can see the files exported in output-path which I believe is the files that I need to deploy in static hosting space. But when I host the same files in my local server or Github pages, they are still blank. Not sure what's wrong here.
Replies
3
Boosts
0
Views
4.1k
Activity
Apr ’22
How to host multiple docarchives on a single http server?
I have a few different projects and a ton of tutorials I want to host on the same http server... is this possible? I watched the Host and automate your DocC documentation session, but it seemed to only work with those rules for one docarchive. I know someone filed feedback for prefixes (https://developer.apple.com/forums/thread/682276)... is this possible already? Thanks.
Replies
3
Boosts
0
Views
3.3k
Activity
Feb ’22
DocC documentation can't be rendered with Apache on CentOS 7
I downloaded the sample code project 'SlothCreator' from here then exported a SlothCreator.doccarchive file. I placed the SlothCreator.doccarchive in /var/www/html/. I use Apache web server on CentOS 7. My .htaccess file is as follows. # Enable custom routing. RewriteEngine On # Route documentation and tutorial pages. RewriteRule ^(documentation|tutorials)\/.*$ SlothCreator.doccarchive/index.html [L] # Route files and data for the documentation archive. RewriteRule ^(css|js|data|images|downloads|favicon\.ico|favicon\.svg|img|theme-settings\.json|videos)\/.$ SlothCreator.doccarchive/$0 [L] # If the file path doesn't exist in the website's root ... RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-d # ... route the request to that file path with the documentation archive. RewriteRule .* SlothCreator.doccarchive/$0 [L] I confirmed that the RewriteEngine works well. I try the following urls then see error message "An unknown error occurred." or "The page you’re looking for can’t be found." http://localhost/documentation/SlothCreator => "An unknown error occurred." http://localhost/SlothCreator.doccarchive/index.html => "The page you’re looking for can’t be found." Can I know what the problem is? Doesn't it work with CentOS?
Replies
4
Boosts
0
Views
2.3k
Activity
Dec ’21
Missing search field in hosted documentation
I found out docC is missing search field in hosted documentation, that is currently for example in documentation tool jazzy (https://pspdfkit.com/blog/2016/adding-live-search-to-jazzy/). This is useful feature that should have every documentation. I would consider it as one of the vital feature for every documentation. Could we expect this feature someday ? Thanks for answer.
Replies
2
Boosts
0
Views
1.1k
Activity
Sep ’21
Guideline 2.3.4 - performance- Accurate Metadata
hey guys I’m in the process of uploading my app and I keep getting stopped by only one part they are telling me to: -include framing around the video screen capture of the app include device images and/or device frames but I thought I did all that but again im new to this. Can anyone help? Image of what I’m talking about below.
Replies
1
Boosts
0
Views
2.4k
Activity
Sep ’21
DocC generated index.html inside .doccarchive showing blank page when opened in browser
Hi, I'm having trouble displaying DocC in the browser. I tried SlothCreator example project generated .doccarchive as well, but the result is the same. index.html once opened shows blank page on all the browsers - Safari, Chrome etc. Hopefully its possible to see how it will look like before hosting on the website. Regards, Milos
Replies
3
Boosts
0
Views
1.2k
Activity
Jul ’21