Comments (4)
There's nothing in progress right now, so adding a note right now would be good I think -- it would also act as reminder to emphasize this during the rewrite.
from documenter.jl.
Related to #2321. In general, yes, I think we expect the users to add Documenter to their local environment, likely under the docs/
directory in their package. So adding at least a small note about that would probably be good, although I feel that a good solution is to re-think the whole getting started guide.
from documenter.jl.
Thanks - I guess it then comes down to the question of how likely is it that this rewrite happens reasonably soon? Mentioning docs/
could be a 15 minute PR which might help people immediately with quite a fundamental first step, but I also get the point about not wanting to tinker with things now if everything gets rewritten soon.
from documenter.jl.
Ok. here's a first attempt:
from documenter.jl.
Related Issues (20)
- Emoji support HOT 3
- Hidden leading lines in @repl blocks add an extra line HOT 2
- Document how to manually clean up `gh-pages` HOT 8
- Out-of-repo deployment doesn't work for me HOT 17
- Documentation for "Generator Expressions" is 8th result when searching julia docs for "Generator" HOT 2
- Search filter toggle buttons have broken UI [regression] HOT 3
- Surface advanced search functionality [feature]
- Keep cursor in search box when adjusting filters [feature]
- De-selecting a search category is sometimes ignored. [bug] [low priority]
- Many locations are listed repeatedly in the search index HOT 2
- Theme display dropdown and actual theme do not align at first [bug] [low priority]
- Compile .css files in CI rather than checking in compiled files HOT 1
- Add search benchmarks HOT 3
- `modules` argument to `makedocs()` conflates availability with doctests HOT 1
- Warn/error when search index is too big
- Unhelpful error during ?template expansion? HOT 2
- ERROR: LoadError: The repo path⦠should not contain the protocol HOT 1
- `&`-s not escape in search results
- New search window does not appear [intermittent] [bug] [regression] HOT 4
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 documenter.jl.