Comments (6)
@JuroOravec While I like the idea of using the library for it's own documentation, I also like the idea of publishing the docs on GitHub Pages and not have to worry about a separate service/server.
@GabDug That looks really good. Would love to get that structure in place. Though I think a lot of the work will be to split the current readme into logical chunks with good section names.
from django-components.
Just a cheeky thought. I reckon some sort of documentation builder would be used for this. But if the website had a custom landing page, or something like that, it'd be cool to build it with Django and Django components. https://github.com/meeb/django-distill can be used to build static sites with Django.
from django-components.
As the README is already using Markdown, I would say mkdocs-material
may be a good fit. I've been working with mkdocs for a while now, so I can contribute to the setup around Mkdocs setup and its CI if help is wanted :)
from django-components.
@GabDug Did you have any chance to make any more progress on this? I think it would make sense to split this work up into several parts, så that just moving what we have could be one step. During the last weeks the README has changed a lot, so I'm not sure this PR will be easy to rebase. If we start with just a split we can keep iterating on the new version while other work in ongoing?
from django-components.
Maybe add an additional link to the docs in the "About" section of the gh project page? - Ok the code is only merged but the page is not yet up. So I was too early to ask...
from django-components.
@dalito Yes, when we get this working (this is my first time fiddling with this) we'll make sure it's replacing the current mega-README :)
from django-components.
Related Issues (20)
- Auto-reload server when saving component file
- Allow dynamic slots and fills HOT 1
- Template caching isn't working HOT 1
- Allow different apps to have different settings HOT 1
- Invalid block tag ... 'component'. Did you forget to register or load this tag? error HOT 20
- Warnings (probably errors) when building documentation HOT 3
- Allow dynamic components HOT 5
- feat: React-like render functions (or functional components) and CachedTemplate HOT 3
- Use variables in JS / CSS and caching thereof HOT 15
- Release 0.93 did not trigger documentation build HOT 6
- Hook into the render process to allow to modify the rendered content HOT 1
- RequestContext not populated with context processors on async request HOT 4
- First class support for HTML fragments HOT 9
- Support for AlpineJS in slots HOT 3
- Broken link in documentation HOT 2
- Docs not deployed to gh-CDN HOT 5
- Crazy idea: Auto-convert RadixUI from JSX to django-components with LLM? HOT 3
- Unexpected behaviour of `ComponentDependencyMiddleware` in combination with `as_view` usage HOT 2
- 0.100 breaks string based BASE_DIR HOT 3
- 0.100: TypeError: the 'package' argument is required to perform a relative import HOT 9
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 django-components.