Comments (6)
The icons and json file should not be inside the tgz. Follow the sample structure here: https://github.com/Kapeli/Dash-User-Contributions/tree/master/Sample_Docset. Don't worry about specific_versions
as I don't think you'll be using it for CPAN.
Dropbox is fine. When you submit the pull request, add a comment with the Dropbox link and I'll take it from there.
Please note that the final tarball that gets distributed might be a bit larger than 140M, because it'll get converted to an indexed tar format which adds a bit of extra space. It shouldn't exceed 200M though.
from dash-user-contributions.
Just to make sure I grok what should be in the submission (I'm probably reading too much into this)
- README.md
- CPAN.docset.tgz
- Contains the actual docset (plist/resources/database/html/etc)
- docset.json
- icon.png
- [email protected]
Also, I think I'm going to do one more run on this thing to add the TOC info. Is there a way to add a CSS file as well, or do I need to inline everything?
from dash-user-contributions.
Yep, those files are all that's needed. Don't worry too much about missing something, I'll check and let you know.
Also, I think I'm going to do one more run on this thing to add the TOC info. Is there a way to add a CSS file as well, or do I need to inline everything?
The docset is just like any folder that contains HTML files. You can add a CSS file and then include it in your HTML files as per usual. Inline CSS would increase the unarchived size, so I'd recommend against it.
from dash-user-contributions.
awesome. thanks, I should have something for you in the next few days. (script takes about 26 hours to run)
from dash-user-contributions.
Hopefully this is the last run before I get something to you. Added styling and syntax highlighting.
from dash-user-contributions.
Looks good 👍
from dash-user-contributions.
Related Issues (20)
- Request: Shiny for Python
- xarray docset shows with name "html" not "xarray"
- Request: Julia package docsets from JuliaHub.com
- Separate docsets for GNU Guile 2 and 3 HOT 1
- Repo size will continue to grow unless docset archives are eliminated from git history HOT 1
- Support for other compression methods/git LFS for docsets > 100MB? HOT 4
- Snowflake
- Request: pydantic
- Possibility of cross-page table of contents HOT 1
- geopandas docs HOT 1
- clojuredocs.org docset is very outdated — last update 2018 HOT 2
- PHP docset outdated HOT 1
- docsetcontrib script HOT 3
- texinfo docset generator (esp. GNU Make) HOT 1
- Filter out CDK and awscc docsets HOT 2
- Feature Request: OpenSearch Client Support
- Feature Request: Index/Search Local EPUB Files
- Feature Offer: LLVM and Clang HOT 1
- scikit-image 0.22 docset seems to lack API docs HOT 18
- Vulkan docset doesn't let you search for vkCmdPushDescriptorSetWithTemplateKHR HOT 1
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 dash-user-contributions.