hunvreus / carte Goto Github PK
View Code? Open in Web Editor NEWSimple Jekyll-based documentation site for APIs.
Home Page: http://wiredcraft.github.io/carte/
License: MIT License
Simple Jekyll-based documentation site for APIs.
Home Page: http://wiredcraft.github.io/carte/
License: MIT License
This would probably be better served through a separate project, but it would be pretty useful to have a grunt and/or gulp plugin available to generate the static documentation at build-time.
I'm using jekyll 1.3.0 and tried to start carte but run into the next error.
root@mircea:/home/mircea/workspace/carte# jekyll serve --watch
Configuration file: /home/mircea/workspace/carte/_config.yml
Source: /home/mircea/workspace/carte
Destination: /home/mircea/workspace/carte/_site
Generating... done.
error: undefined method `to_path' for #<Pathname:_site>. Use --trace to view backtrace
Is not compatible with jekyll 1.3.0 ?
I'll feel puzzled when the doc becomes large.
$ open _posts/201
2012-12-29-response-status-codes.md 2013-01-03-github-getusers.md 2013-01-03-user-update.md 2013-01-08-user-whoami.md
2013-01-03-access-denied.md 2013-01-03-status-channels.md 2013-01-04-server-create.md
2013-01-03-github-getorgs.md 2013-01-03-status-orgs.md 2013-01-04-server-enable-user.md
2013-01-03-github-getrepos.md 2013-01-03-user-logout.md 2013-01-08-user-is-initialized.md
Specially when type 201 <tab>
to find out old posts.
For example:
http://devo-ps.github.com/api.teamchat.io/ : this is the home page
http://devo-ps.github.com/api.teamchat.io/#about : this should has the same effect when i click Workflow Of APIs
I have installed it on my server and it shows the log
Server address: http://127.0.0.1:4000/
But I want to change it to public address, Can you help me how i can do this.
Another change in Jekyll, whereby the entries in the posts where layout: nil
is specified should now be changed to layout: null
i want a feature that is:
I noticed that the page renders as a 'hide all' when it loads, I would like it to 'show all'. Where do I need to change the js file to do this?
Thanks
You should change the #sidebar css position : absolute to position: fixed.
it seems more beautiful :))
This project looks awesome. I intend to use it for my API docs :)
However - I notice a lack of any license on this repo. Please do correct me if I'm wrong, but I believe that without an explicit license, the default is copyright with no open licensing.
Could you correct me, or add a license please?
Thanks
Add support for a message informing the reader of the stability of each method.
after i changed or added an api. it is better to show something different. for example, highlight it. then, the frontend could easy to understand what has changed.
prefer add it to _config.yml
, for example:
highlighted: ['About', ...]
Rendered HTML shows the text display representation of the relative filesystem file path, ie
_posts/2012-12-24-delete-a-thing.md
instead of custom defined path property
/stuff/:id
Im a Jekyll/YAML newbie, but seems like path may now be reserved, and therefore overridden. Changing the variable name in the post to something else, ie resturi
and the equivalent change in template in index.html fixed the issue.
So in your post, the line:
path: '/stuff/:id'
changed to :
resturi: '/stuff/:id'
and in index.html, changed post.path
to post.resturi
<a name='{{ post.url }}' href='#{{ post.url }}'><h2>{% if post.type %}<code><b>{{ post.type }}</b> {{ post.path }}</code> {% endif %}{{ post.title }}</h2></a>
changed to :
<a name='{{ post.url }}' href='#{{ post.url }}'><h2>{% if post.type %}<code><b>{{ post.type }}</b> {{ post.resturi }}</code> {% endif %}{{ post.title }}</h2></a>
Jekyll now has data files and custom collections. I'm considering using either of them in a newer version of carte (most like data files).
Your github page 404s: http://devo-ps.github.io/carte
I'm just launched my doc site[1] using this Jekyll layout and love the simplicity and cleanness of it. Thanks!
But today I went back to make sure attributions were correct and realized that your license doesn't name anyone[2]. Who should I list and how?
1 - http://docs.web2project.net/
2 - https://github.com/Wiredcraft/carte/blob/gh-pages/LICENSE.md
New version of Jekyll : Deprecation: The 'pygments' configuration option has been renamed to 'highlighter'. Please update your config file accordingly. The allowed values are 'rouge', 'pygments' or null.
Thus, _config.yml line 4, needs to be changed from :
pygments: true
to:
highlighter: pygments
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.