Commit Graph

37 Commits

Author SHA1 Message Date
Georgios Kalpakas
1ce45472eb docs(app): fix styling of left sidenav, add FontAwesome
Since the structure was a little different than the prototype,
classes/styles where not applied correctly to the links in the left
sidenav. This commit fixes the issue.

I also added FontAwesome, in order to be able to display icons until the
Material Design icon-font is released. Since this is a temporary meassure,
I didn't added as a bower dependency; just added a `font-awesome` folder
in assets and added `font-awesome/css/font-awesome.css` to the stylesheets
of each deployment (under `docs/config/services/deployments/`.
2014-12-08 20:40:42 -05:00
Georgios Kalpakas
68d490ee86 docs(app): refactor the Docs App based on the MD prototype
I incorporated the prototype detailed in https://github.com/gkalpak/angular.js/issues/3.

Things that are different from the prototype (besides using actual data):

 * The left sidenav (toc) is not styled properly (or even readably).
 * The subheaders in the left sidenav are not "stickying" properly (only `ng` becomes sticky).
 * Icons are missing (since we are not using FontAwesome). E.g. search-fab, toc-toggle, results
 * In the right sidenav (search) there are some unwanted horizontal scrollbars.
   (This section probably needs rethinking anyway.)
 * I have implemented a `responsiveMenu` directive to show the options in the header-menus
   (Learn/Develop/Discuss). The purpose is to show the options in a "dropdown-ish" menu on larger
   screens and using a BottomSheet on smaller. At the moment a BottomSheet is used on every
   screen-size.

Notes:

 - Still no version-picker and breadcrumbs (I have left the original implementation of those two
   commented out).
 - I have replaced the previous docs.css with a new one containing the style of the prototype.
   I have renamed the old one to `docs_old.css` and left it there temporarily for quick reference.
   We need to clean up this and the rest of the old CSS files.
 - The main content area is totally unstyled and needs some love (a lot actually).

I have also "sprinkled" the code with a few more TODOs/FIXMEs.

(For more details on known issues and missing features take a look at
 https://github.com/gkalpak/angular.js/issues/3)
2014-12-08 20:40:41 -05:00
Georgios Kalpakas
c820655ccd docs(app): minor refactoring of 'docs/app/src/*' 2014-12-08 20:40:41 -05:00
Peter Bacon Darwin
d6064acc6a chore(docs): update deployments to use angular material and not bootstrap 2014-11-22 18:05:30 +00:00
Peter Bacon Darwin
b65595cc55 chore(docs): remove unused cookie service and module 2014-11-22 18:04:50 +00:00
Kent C. Dodds
f30163e63a docs(nav): highlight current nav-index-listing
Color the current nav-index-listing item dark red
to make it easier to know where you are.

Closes #9970
Closes #9974
2014-11-15 11:30:23 +01:00
Peter Bacon Darwin
54ddca537e chore(docs/search): ensure that default search goes to API first
Closes #9736
2014-10-25 09:39:24 +02:00
Peter Bacon Darwin
353de4f531 chore(docs): apply the anchorScroll offset feature to the docs app
Closes #9360
2014-10-12 17:55:43 +01:00
bolasblack
aa1c23a2bf docs(versions): remove the trailing slash in URLs when switch versions
Because `https://docs.angularjs.org/api/` can handler the trailing slash,
but `https://code.angularjs.org/1.2.24/docs/api` can not.

Fix #9043
Closes #9045
2014-10-09 11:52:45 -07:00
Peter Bacon Darwin
e522c25fd4 chore(docs): remove unused code 2014-09-25 05:43:20 +01:00
Peter Bacon Darwin
8ab673d430 chore(docs): ensure DI annotations are in place 2014-09-25 05:31:14 +01:00
Peter Bacon Darwin
e81ae1464d chore(docs): show error 404 without partial failing
We can move the test back into the main describe as it no longer causes an
error message to be logged
2014-09-24 07:32:04 +01:00
Peter Bacon Darwin
ace40d5526 chore(docs): refactor the docs app search for better bootup time
This commit refactors how the search index is built. The docsSearch service
is now defined by a provider, which returns a different implementation of
the service depending upon whether the current browser supports WebWorkers
or now.

* **WebWorker supported**: The index is then built and stored in a new worker.
The service posts and receives messages to and from this worker to make
queries on the search index.

* **WebWorker no supported**: The index is built locally but with a 500ms
delay so that the initial page can render before the browser is blocked as
the index is built.

Also the way that the current app is identified has been modified so we can
slim down the js data files (pages-data.js) to again improve startup time.

Closes #9204
Closes #9203
2014-09-23 18:58:45 +01:00
Peter Bacon Darwin
3952408cf1 chore(docs): improve searching by member
The keywords processor now also extracts the members (i.e. method, properties
and events) into its own search term property. These are then used in the lunr
search index with higher weighting that normal keywords to push services that
contain the query term as a member higher up the search results.

Closes #7661
2014-09-04 14:23:04 +01:00
Igor Minar
550ba01b32 fix(docs): don't throw exception on the 404 page
Closes #8518
2014-08-29 16:13:11 -07:00
Jeff Cross
925b2080a0 fix(docs): change plnkr form to open in same window
Form previously posted to target="_blank", but pop-up blockers were causing this to not work.
If a user chose to bypass pop-up blocker one time and click the link, they would arrive at
a new default plnkr, not a plnkr with the desired template.

This fix removes the _blank target, causing the plnkr to open in the current window/tab.
2014-07-24 14:20:31 -07:00
Trey Hunner
a54d4600b3 style: fix whitespace issues
Closes #8277
2014-07-21 14:52:41 -07:00
Peter Bacon Darwin
aa7dbf0cf7 docs(indexPage): move latest versions to the top
Closes #7513
2014-07-18 21:49:43 +01:00
Peter Bacon Darwin
52cae5b59b docs(search): fix search submit functionality
When the search input box was submitted (i.e. by pressing enter) the
app was supposed to take you to the first item but this was not happening.
It turns out the app was just reading the wrong property for the path to
the item.

Closes #3078
2014-05-16 14:33:09 +01:00
Peter Bacon Darwin
6712ca5a6c docs(search): set minimum length to 2
With the minimum search length set to 3, it was not possible to search for `$q`.
Changing this to 2 fixes that without really upsetting the search display, since we
only display the first 40 API and 14 non-API items anyway.

Closes #3078
2014-05-16 14:23:35 +01:00
Jack Hsu
8b91aa64b7 docs(directives): fix code lang matching
Closes #7339
2014-05-04 20:46:38 +01:00
Peter Bacon Darwin
8e404c4dc1 docs(directives): remove line numbers from code blocks 2014-04-29 12:33:20 +01:00
Peter Bacon Darwin
d90f83cda8 docs(examples): don't attempt to convert example content from JSON
There are some files in the examples that look like JSON and the default
$http transformResponse handler was trying to convert these from strings
to object. An example was the style.css file in the
https://docs.angularjs.org/api/ng/type/ngModel.NgModelController docs.

This commit fixes this by simply removing this transform when loading
these files.
2014-04-28 22:18:55 +01:00
Peter Bacon Darwin
bdec35cebc docs(examples): use form POST to create Plunkers
The previous solution for opening Plunkers from the docs relied on tight
coupling between the docs site and the plunkr site, in particular the
URL to the example code on the docs server was hard coded in the Plunker
site.

This change goes back to the old POST method of creating a Plunker, but
with a subtle difference: In the very old docs, the content was injected
directly into the example HTML at build time.  This was easy enough to
do as the example actually ran in the current page but also increased
the size of the doc page.

The new examples are run in completely separate iframes. This new version
of showing a Plunker loads the file content for the Plunker from the
server by accessing the example's manifest.json file using $http requests.

This also has the additional benefit that you can now generate plunkers
from examples that are running locally or, frankly, in any folder on any
server, such as personal builds on the Jenkins CI server.

Closes #7186
Closes #7198
2014-04-23 12:43:40 +01:00
Michał Gołębiowski
92e8289c12 refactor(jqLite): change leftover element.bind/unbind to element.on/off 2014-04-22 16:03:22 +02:00
Peter Bacon Darwin
b517f49a80 chore(docs/app): remove redundant code directive
Closes #7000
2014-04-06 17:27:53 +01:00
Peter Bacon Darwin
6b7a1b82bc chore(docs/app/tutorials): improve helper directives 2014-04-04 12:06:40 +01:00
Peter Bacon Darwin
a526ae8f77 docs(tutorial): synch step 0 with angular-seed 2014-04-04 08:30:06 +01:00
Peter Bacon Darwin
d09056d287 docs(runnableExamples): add "edit in Plunker" button
The "runnableExample.template.html" template overrides the one in the
dgeni-packages "examples" package with a similar template that also has
a link to a special Plunker URL that can pull in the example from our
code.angularjs.org website.
2014-03-17 12:43:10 +00:00
Stéphane Reynaud
78165c224d docs(tutorial): display button icons (Previous, Live Demo, ...)
In relation to https://github.com/angular/dgeni-packages/pull/8

Closes #6641
2014-03-11 10:19:42 +00:00
Peter Bacon Darwin
853999de10 docs(404 errors): provide a better 404 experience
It is a bit rough and ready but does a better job than nothing.
2014-03-07 20:05:58 +00:00
Peter Bacon Darwin
27b7fa3914 docs(directives): ensure that the back-to-top directive resets location
Closes #6512
Closes #6499
2014-03-02 15:38:04 +00:00
Peter Bacon Darwin
3b5480e9fc chore(doc-app): ensure only canonical paths get sent to Google Analytics
Before we were simply sending the current location, but multiple URLs map
to the same document.
Now, we use the canonical path of the current document if available and
fall back to the $location path otherwise.
Includes tests!!

Closes #6402
2014-02-22 10:07:31 +00:00
Peter Bacon Darwin
b488bbf4bf chore(doc-app): remove invalid line of code 2014-02-19 16:07:56 +00:00
Peter Bacon Darwin
ad6767949c chore(docs): cope with trailing slash and "index" in URLs
Closes #6295
2014-02-18 06:26:24 +00:00
Matias Niemelä
713c8e629d docs(design): ui-fixes for examples, layout and API components 2014-02-17 00:20:26 +00:00
Peter Bacon Darwin
389d4879da chore(doc-gen): new docs
chore(doc-gen): implement dgeni
2014-02-16 19:03:41 +00:00