Commit graph

1071 commits

Author SHA1 Message Date
Igor Minar
6e0ff5fa96 fixing the dev guide ordering 2011-06-07 07:44:49 -07:00
Vojta Jina
4cdce2d30b Docs: Error 404 page with simple suggestion for new links 2011-06-06 23:10:30 -07:00
Igor Minar
48e69ed4d1 moving the angular.mock docs down in the api list 2011-06-06 23:10:30 -07:00
Igor Minar
c35b0a7907 yet another docs batch 2011-06-06 23:10:30 -07:00
Igor Minar
805bb5bb6e fixing broken docs links 2011-06-06 23:10:30 -07:00
Kenneth R. Culp
4224e8e371 images for guide 2011-06-06 23:10:29 -07:00
Igor Minar
dd44e00ddd docs css fix for content-list indentation 2011-06-06 23:10:29 -07:00
Igor Minar
3069566073 api doc fixes from ken 2011-06-06 23:10:28 -07:00
Igor Minar
759e6ea8ed docs css fixes 2011-06-06 23:10:28 -07:00
Igor Minar
c4989d8979 add new version of api/angular doc 2011-06-06 23:10:28 -07:00
Igor Minar
af710c3ac1 fix wrapping api links into code element 2011-06-06 23:10:27 -07:00
Igor Minar
e89ef35d05 make *.angularjs.org analytics work on subdomains 2011-06-06 23:10:27 -07:00
Igor Minar
2ba3c3ee57 fix getting started docs 2011-06-06 23:10:27 -07:00
Igor Minar
c6dbdde6dc fix hashpath prefix for docs/sitemap/etc 2011-06-06 23:10:27 -07:00
Igor Minar
f8417b48be docs app css/js/html rewrite 2011-06-06 22:52:02 -07:00
Igor Minar
7f1e2e4846 new batch of docs 2011-06-06 22:52:02 -07:00
Igor Minar
5533e48dea work in progress 2011-06-06 22:52:02 -07:00
Vojta Jina
16d0354f93 Load GA script using $script loader 2011-06-06 22:52:02 -07:00
Vojta Jina
350ee31107 Google Analytics - basic page tracking for docs 2011-06-06 22:52:02 -07:00
Vojta Jina
2da07127e4 Add doc:tutorial-instructions widget 2011-06-06 22:52:01 -07:00
Igor Minar
bc2ca384b1 move docs/content/intro to docs/content/misc 2011-06-06 22:52:01 -07:00
Vojta Jina
2380943106 Allow "section/" links pointing to "section/index" 2011-06-06 22:52:01 -07:00
Vojta Jina
43b2cd45f0 Allow relative links in docs
So you can use links without section when they link within the section.
2011-06-06 22:52:01 -07:00
Vojta Jina
e389911a35 Change warning to log place first and then link 2011-06-06 22:52:00 -07:00
Vojta Jina
fd357b4cd2 Remove trailing ws 2011-06-06 22:52:00 -07:00
Igor Minar
924ffafc51 fixing broken links 2011-06-06 22:52:00 -07:00
Vojta Jina
3616716615 Indent the API reference list 2011-06-06 22:52:00 -07:00
Vojta Jina
76df0db598 Fixed docs search input with
And couple of missing semi-colons...
2011-06-06 22:52:00 -07:00
Vojta Jina
7fe46e8d7e Bit of refactoring 2011-06-06 22:51:59 -07:00
Vojta Jina
864da8b553 Couple of todos 2011-06-06 22:51:59 -07:00
Vojta Jina
d62b8407cf Fixed couple of failing tests in docs
These tests were failing because of rewriting urls into new 'section' format,
i.e. angular.scope -> api.angular.scope
2011-06-06 22:51:59 -07:00
Vojta Jina
8cb84eac68 Log warning for every non existing link instead of throwing exception
Guess we don't want to stop doc generating process because of non-existing link, so just log warning and continue...
2011-06-06 22:51:59 -07:00
Vojta Jina
2e0e732cad Check whether links do exist and throw exception 2011-06-06 22:51:59 -07:00
Vojta Jina
22f9354c21 Fix sitemap include (to work on case sensitive linux) 2011-06-06 22:51:59 -07:00
Igor Minar
0c75a96917 new version of the xhr service 2011-06-06 22:51:59 -07:00
Igor Minar
14407921c7 reorder docs main menu items 2011-06-06 22:51:58 -07:00
Igor Minar
8920381b44 fix docs css 2011-06-06 22:51:58 -07:00
Igor Minar
3751f172b3 add new batch of tutorial docs and images 2011-06-06 22:51:58 -07:00
Igor Minar
3776e08db0 new docs skin - WIP 2011-06-06 22:51:58 -07:00
Igor Minar
c1debfb81d fix docs landing page redirection 2011-06-06 22:51:58 -07:00
Igor Minar
0fb37b08e7 add resource merging 2011-06-06 22:51:58 -07:00
Igor Minar
2094bc8f61 make docs/writer.js copyDir recursive 2011-06-06 22:28:39 -07:00
Igor Minar
a1f3725c0f ignore non .ngdoc files 2011-06-06 22:28:39 -07:00
Kenneth R. Culp
4ac234833a Don't forget the_end... 2011-06-06 22:28:39 -07:00
Kenneth R. Culp
9d9117384f Latest greatest tutorial udpates. 2011-06-06 22:28:38 -07:00
Igor Minar
525e444a0f temporary hack to strip all the extra chars from google docs 2011-06-06 22:28:38 -07:00
Igor Minar
fd112877f8 fix link to the tutorial page 2011-06-06 22:28:38 -07:00
Igor Minar
6181ca600d new batch of tutorial docs 2011-06-06 22:28:38 -07:00
Misko Hevery
11e9572b95 Move documentation under individual headings 2011-06-06 22:28:38 -07:00
Misko Hevery
b6bc6c2ddf fix syntax highlighting on the javascript 2011-06-06 22:28:37 -07:00
Misko Hevery
ea6b87c24b renamed tutorial so that it would sort properly 2011-06-06 22:28:37 -07:00
Kenneth R. Culp
e205bd7137 Update tutorial docs. 2011-06-06 22:28:37 -07:00
Igor Minar
bd7e68f12f process only tutorial files 2011-06-06 22:28:37 -07:00
Kenneth R. Culp
0a604bdb90 Tutorial files for your perusal. 2011-06-06 22:28:37 -07:00
Igor Minar
4738d49e1c new skin WIP 2011-06-06 22:28:36 -07:00
Vojta Jina
1abdc097b2 JSTD adapter for running e2e tests
Couple of changes into angular.scenario runner:
 - add autotest config (runs tests when document ready)
 - update ObjectModel (forwards events)
 - use only one ObjectModel instance for all outputters
 - expose error msg and line number in ObjectModel.Spec and ObjectModel.Step
 - fix generating spec.ids
 - fix 'html' output so that it does not mutate ObjectModel

Couple of changes into docs / generator:
 - rename copy -> copyTpl
 - move docs/static into docs/examples (to avoid conflict with jstd proxy)

Running all docs e2e tests:
========================================================
1/ compile angular-scenario, jstd-scenario-adapter
>> rake compile

2/ build docs
>> rake docs

3/ start jstd server
>> ./server-scenario.sh

4/ capture some browser

5/ run node server to serve static content
>> node ../lib/nodeserver/server.js

6/ run tests
>> ./test-scenario.sh
2011-05-19 09:43:56 -07:00
Igor Minar
b85e95709d fix widget example code 2011-05-13 07:15:59 -07:00
Vojta Jina
f85c82acd6 Fix some typos, missing semi-colons, etc...
This is a combination of 4 commits:
* Fix some small typos, missing semi-colons, etc.
* Fix comment for angular.scenario.SpecRunner.run method
* Fixed some missing semi-colons in cookbook
* Fixed missing semi-colon in nodeserver/server.js
2011-04-25 08:17:17 -07:00
Igor Minar
97bdf979a1 fix Cookbook link in getting started doc 2011-04-20 15:14:45 -07:00
Anthony Lieuallen
e7c22e8153 spelling fix 2011-04-15 16:01:47 -04:00
Igor Minar
81063a748c fix typo in angular.widget docs 2011-04-10 14:16:08 -07:00
Igor Minar
e5419db6c7 fix indentation regexp for doc:examples 2011-04-07 12:34:34 -07:00
Pepper Lebeck-Jobe
4da65d0e8c Fixes some links and types in the DI docs. 2011-03-28 23:40:56 -07:00
Igor Minar
d95a6925cd fix broken 'downloading' links 2011-03-23 15:25:05 -07:00
Pepper Lebeck-Jobe
b4d680a921 Fixes two links on the conribute page. 2011-03-22 10:18:07 -07:00
Pepper Lebeck-Jobe
ff4480be65 Fixes a typo xmlsn -> xmlns 2011-03-22 10:10:55 -07:00
Misko Hevery
5b05c0de03 @require in ngdoc now takes reason for dependency 2011-03-11 14:16:52 -08:00
Igor Minar
5bf7ff5a3e fixing broken e2e tests 2011-03-03 13:50:12 -08:00
Igor Minar
a01d888eec adding dependency injection docs 2011-03-03 00:16:20 -08:00
Igor Minar
28800a48ad renaming guide.contribute.ngdoc to contribute.ngdoc 2011-03-02 23:19:59 -08:00
Igor Minar
dea72be0cc docs cleanup and improvements
- moving 'downloading' from devguide to "misc"
- syncing the latest version of 'downloading'
- getting rid of junk files
2011-03-02 23:14:13 -08:00
Igor Minar
945056b166 linking function should return bound scope
angular.compile()() returns {scope:scope, view:view},
this isn't useful at all and only makes tests more verbose.
Instead, this change makes the linking function return scope directly
and if anyone needs the linked dom there are two ways to do it
documented in angular.compile.

other changes:
- moved angular.compile docs to the compiler so that they are closer to
  the compiler
- fixed some typos and updated angular.compile docs with the new return
  value
2011-03-01 17:09:25 -08:00
Igor Minar
5fc2b96b97 docs.css should not inline all pragraphs, only those in lists 2011-02-23 15:52:29 -08:00
Janet Davies
eea0de6db4 Rewrite of the "Contributing" section of the DevGuide 2011-02-22 17:42:00 -08:00
Igor Minar
d15165f207 fixing typo in guide.overview 2011-02-22 15:49:46 -08:00
Kenneth R. Culp
fe743e31f8 Rewrite of the overview section of the dev guide 2011-02-22 15:09:44 -08:00
Misko Hevery
55ce859998 fix documentation for ie 2011-02-22 14:48:53 -08:00
Misko Hevery
65243b7d60 corrected new lines in @link 2011-02-18 11:52:57 -08:00
Misko Hevery
c90abf057b Changed the angular.compile(element)(scope[, cloneAttachNode]) 2011-02-16 08:59:57 -05:00
Misko Hevery
496e6bf901 refactored quickClone to cloneNode and exposed it on jQuery 2011-02-16 00:49:16 -05:00
Misko Hevery
0a5c00abf8 Add public API to retrieve scope from element. 2011-02-16 00:48:22 -05:00
Igor Minar
4f6fe1d479 adding testimonials page to docs
this is just a temporary move so that the content doesn't get lost.
in the long term we want this to be part of the main site.
2011-02-10 15:40:38 -08:00
Misko Hevery
0f19cd3625 corrected missbehaved example 2011-02-09 20:11:34 -08:00
Janet Davies
c1caf2560a Update Dev Guide Downloading content (to be moved to Contributing later). 2011-02-09 11:19:30 -08:00
Kenneth R. Culp
b07cc0e392 Cleanup of the Getting Started guide 2011-02-09 11:01:54 -08:00
Igor Minar
f943180e34 renaming fag.ngdoc to faq.ngdoc 2011-02-08 20:42:32 -08:00
Igor Minar
d600c608e3 markdown pre-processor should strip all the extra indentation
- split trim into trim and indent
- merged my indentation code with trim
- cleaned up some small issues
2011-02-07 23:56:51 -08:00
Igor Minar
f3a39a6418 docs should print usage for services that are functions 2011-02-07 23:55:02 -08:00
Igor Minar
f00b157841 @property should require type and description should be markdownified 2011-02-07 23:55:02 -08:00
Igor Minar
ae20f0c1b3 adding docs for angular.markup and angular.attrMarkup 2011-02-07 23:55:02 -08:00
Igor Minar
94bf24e3b6 fix angular.js file path detection in docs 2011-02-04 14:11:53 -08:00
Misko Hevery
882f412d57 Added remainder of the cookbook 2011-02-03 20:03:38 -08:00
Misko Hevery
0d4def68ae added more cookbook: work in progress 2011-02-03 20:03:38 -08:00
Misko Hevery
245b60d69a addded cookbook 2011-02-03 13:26:48 -08:00
Misko Hevery
ba6b68b6ae changed the documentation @example to use <doc:example> 2011-02-01 10:00:09 -08:00
Misko Hevery
ed768ebc53 Developer guide documentation 2011-02-01 09:58:37 -08:00
Misko Hevery
e5a3acacad corrected sitemap.xml format 2011-01-27 09:53:20 -08:00
Igor Minar
75de7395bb validator doc example should not be escaped 2011-01-26 23:44:21 -08:00
Misko Hevery
bd33f60276 Added part of guide documentation and supporting changes to doc generator 2011-01-26 23:31:15 -08:00
Igor Minar
7a48ee6aa9 fix deprication typo in the doc generator 2011-01-26 15:37:22 -08:00
Misko Hevery
d8acfe7389 add @this and @exampleDescription tags
(also removed markdownNoP, now done through CSS)
2011-01-24 14:23:51 -08:00
Misko Hevery
bf03eb007c Added SiteMap generation to the documentation 2011-01-24 14:23:51 -08:00
Misko Hevery
c2f2587a79 fixed example rendering, add tests for it. 2011-01-24 14:23:51 -08:00
Misko Hevery
70c74a9c4e add @this and @exampleDescription tags
(also removed markdownNoP, now done through CSS)
2011-01-24 14:23:51 -08:00
Misko Hevery
22c5b7059b updated doc styling for methods/properties 2011-01-24 14:23:50 -08:00
Igor Minar
2c0f7ffe3a ngdoc should escape content of pre in markdown 2011-01-19 15:53:58 -08:00
Misko Hevery
050e5d773f verify that issue# 162 was fixed with doc rewrite 2011-01-18 15:32:46 -08:00
Igor Minar
72e554ffeb doc widgets examples should display angular src as CAO instead of DAO 2011-01-18 14:42:23 -08:00
Igor Minar
3bd96609e9 remove script.type attribute from example widgets since its optional in html5 2011-01-18 14:42:23 -08:00
Igor Minar
d73635d573 @returns type in docs should be wrapped in curlies 2011-01-18 14:42:22 -08:00
Igor Minar
1c55123f9c rewrite of several major portions of angular.service docs 2011-01-17 22:16:15 -08:00
Misko Hevery
347be5ae9a fixed select with ng:format
select (one/multiple) could not chose from a list of objects, since DOM requires string ids.
Solved by adding index formatter, which exposed incorrect handling of formatters in select
widgets.
2011-01-14 10:30:00 -08:00
Igor Minar
ab040254f0 tabbing and keyboard shortcut for docs
- first tab goes to the search box, following tabs iterate results
- ctrl+s (FF on mac) or ctrl+alt+s (Chrome on mac) move focus to the
  search box
2011-01-10 21:23:22 -08:00
Igor Minar
4f5d5029c2 offline docs
- freezing syntaxhighlighter and jquery under docs/src/templates/
- for jquery I just used a symlink to lib/jquery not an ideal solution
  but writer.js is not very flexible and I didn't want to mess with it
- changed docs' index.html to point to the local resources
2011-01-10 21:03:50 -08:00
Misko Hevery
f534def0c6 removed unnedded files; switch rake to new doc build script 2011-01-10 14:48:13 -08:00
Misko Hevery
4f22d6866c complete rewrite of documentation generation
- romeved mustache.js
- unified templates
- improved testability of the code
2011-01-10 11:50:11 -08:00
Misko Hevery
47c454a315 change to keydown from keyup; add delayed $updateView
- There was a perceived lag when typing do to the fact that we were
   listening on the keyup event instead of keydown. The issue with
   keydown is that we can not read the value of the input field. To
   solve this we schedule a defer call and perform the model update
   then.

 - To prevent calling $eval on root scope too many times as well as to
   prevent drowning the browser with too many updates we now call the
   $eval only after 25ms and any additional requests get ignored. The
   new update service is called $updateView
2011-01-07 14:39:46 -08:00
Igor Minar
f8151afd90 improve doc app scrollbars 2010-12-10 17:04:56 -08:00
Igor Minar
81d10e819e make the docs angular 'logo' link filename agnostic 2010-12-07 20:43:10 -08:00
Igor Minar
809ca94e1c @returns tag should allow the content to be split into multiple lines 2010-12-07 16:07:14 -08:00
Misko Hevery
58d0e8945d allow documentation to be in external file
* Load templates once instead of per request
* show timing information
* load files ending in .ngdoc and process them
2010-12-06 15:48:40 -08:00
Igor Minar
5480d2a80b fix typo in searchbox placeholder 2010-11-29 16:47:21 -08:00
Igor Minar
95adf3a4d8 searchbar in docs should not scroll away 2010-11-29 16:47:20 -08:00
Igor Minar
cc315ef4cc renaming #section to #main in docs html/css 2010-11-29 16:47:20 -08:00
Igor Minar
41c233ada1 getting rid of #page div in docs index.html 2010-11-29 16:47:19 -08:00
Igor Minar
46091f811b dual scrolling for docs with custom scrollbars 2010-11-29 16:47:13 -08:00
Igor Minar
fde2ccb3f5 docs html/css cleanup 2010-11-29 11:25:38 -08:00
Vojta Jina
bd14a90610 Doc specs: added test for markdown
It should replace markdown between two <pre></pre>***<pre></pre>
2010-11-25 08:51:32 -08:00
Vojta Jina
9f1b9849d8 Small refactor in doc parser 2010-11-25 08:51:32 -08:00
Igor Minar
870547d185 docs for angular.Array.orderBy 2010-11-23 15:44:14 -08:00
Igor Minar
7ee102eecf add a feedback link to the doc pages 2010-11-18 16:53:11 -08:00
Igor Minar
fc7f11d03b add @workInProgress tag and mark all @ngdocs as work in progress 2010-11-18 16:28:42 -08:00
Igor Minar
3c7874b07b don't encode page.name (hash) in docs.js
see discussion in https://github.com/angular/angular.js/pull/158"
2010-11-18 11:56:10 -08:00
Igor Minar
63380bbbda title for index.html should not show raw binding while the app bootstraps 2010-11-18 02:35:30 -08:00
Igor Minar
522ec1a9ec move attribute widgets to widgets.js file
- move @ng:repeat to widgets.js and its specs to widgetsSpecs.js
- move @ng:non-bindable to widgets.js and its specs to widgetsSpecs.js
- make widget.template suitable for attribute widgets
- fix up the js docs for attribute widgets
2010-11-18 02:35:29 -08:00
Igor Minar
d54f09ef29 add spec for incrementing headings 2010-11-18 02:35:29 -08:00
Igor Minar
65989c6f0d add support for {@link} tags within @description and remove implicit linking
use as:
- foo {@link bar}
- foo {@link bar desc}

I'm removing implicit linking because it unintentionally links stuff and
generally interferes with other conversions. We have to link stuff explicitely
from now on.
2010-11-18 02:35:29 -08:00
Igor Minar
4491bbdede docs linkifying regexp should not mess up links alreaded converete by markdown 2010-11-18 02:35:28 -08:00
Igor Minar
a6978b201b make @param type and description non-optional 2010-11-18 02:35:28 -08:00
Igor Minar
28e72cbe6b CSS, Parameters, Returns template changes
- make css section optional
- make returns section optional
- change format of the parameters section
- properly format the Returns section
2010-11-18 02:34:55 -08:00
Igor Minar
916dadd8ec adjust spacing of headings in the main doc div 2010-11-18 02:34:54 -08:00
Igor Minar
ee0e9a4452 adding support for @param.optional 2010-11-18 02:34:54 -08:00
Igor Minar
dd687e2bf5 @returns description should support markdown 2010-11-18 02:34:53 -08:00
Igor Minar
4c69d694d7 make @returns type non-optional 2010-11-18 02:34:53 -08:00
Igor Minar
51a22cf435 group utility methods/objects while sorting stuff for the side bar 2010-11-18 02:34:53 -08:00
Igor Minar
c2c60ab49a remove extra returns tag 2010-11-18 02:34:53 -08:00
Igor Minar
71c2f24fc6 remove extra toolbar directive and support multiple pre's in describe 2010-11-18 02:34:52 -08:00
Igor Minar
c7052f098d add support for @deprecated ng:doc annotation + show warnings in templates 2010-11-18 02:34:31 -08:00
Igor Minar
7d6f5f986e add function.template 2010-11-18 02:34:30 -08:00
Igor Minar
beeb5ff908 fix regexp for @param parsing in ng:docs
There is an extra + in the regexp which causes exponential increase in time
needed to parse a @param annotation when the length of default value increases
linearly.
2010-11-16 14:44:35 -08:00
Igor Minar
4af32de84a docs should use ng:include onload 2010-11-16 13:45:45 -08:00
Vojta Jina
cc749760fd Added basic Services, which support @memberOf and @methodOf 2010-11-15 21:55:37 -08:00
Misko Hevery
b467a50bc7 generate keyword for searches; improved layout of doc 2010-11-15 12:28:08 -08:00
Misko Hevery
a1652057a5 changed to ! notation for indexable apps 2010-11-15 10:04:17 -08:00
Misko Hevery
7e6f999221 added remaining directives and search box. 2010-11-15 10:04:17 -08:00
Misko Hevery
43a4ff4cdf Example snippets now have full html snippets 2010-11-10 21:01:05 -08:00
Misko Hevery
6b8ed42670 Added Directives 2010-11-10 12:02:49 -08:00
Elliott Sprehn
c57df3dc77 Make the docs look a little nicer 2010-11-10 11:01:30 -08:00
Misko Hevery
a7e8a503fd proper trimming of leading whitespace; url restriction to angular.* 2010-11-09 22:27:37 -08:00
Igor Minar
324694a58b Better example widget
- syntax highlighting
- tabless design
- rename widget to doc:example
- rename widget files (wiki_widget.* -> doc_widget.*)
- example section is now optional
2010-11-09 22:27:31 -08:00
Misko Hevery
c048f0d8e8 Added formatter documentation. 2010-11-09 09:15:29 -08:00
Misko Hevery
91b6c5f7ff Added documentation for validators.
BACKWARD INCOMPATIBLE: removed ssn validators, since it is unlikely that most people will need it and if they do, they can added it thorough RegExp
2010-11-07 13:06:55 -08:00
Misko Hevery
dc66687149 added tests for documentation 2010-11-05 15:05:24 -07:00
Misko Hevery
3d6a099d6e changed to showdown from markup. added validator overview 2010-11-05 13:32:37 -07:00
Misko Hevery
47066e70e1 added documentation for ng:include and ng:widget and test for doc collector. 2010-11-04 14:24:31 -07:00
Igor Minar
bbb19a4d16 fixing docs scenario runner template 2010-11-03 12:55:17 -07:00
Igor Minar
a8efd43d25 doc parser should recognize the 'defaults' syntax for params 2010-11-03 09:47:23 -07:00
Misko Hevery
5159eb7635 fix the linky filter 2010-11-03 09:47:22 -07:00
Igor Minar
1ba8c2a33a more documentation for filters 2010-11-03 09:47:22 -07:00
Misko Hevery
659af29adb jsdoc parser + generator + viewer + scenario runner
- parse jsdocs from source code
- generate prerendered (markdown + mustache) partials
- generate json
- generate scenario runner for examples in docs
- basic angular doc viewer
2010-11-03 09:47:22 -07:00
Misko Hevery
62c0e5c460 Fix failing tests for ie, and mark elements as ng-widget, ng-directive, and ng-binding 2010-10-27 15:42:46 -07:00