1. 15 Feb, 2019 1 commit
    • Greg Spencer's avatar
      Remove remaining "## Sample code" segments, and fix the snippet generator. (#27793) · 262f12b4
      Greg Spencer authored
      This converts all remaining "## Sample code" segments into snippets, and fixes
      the snippet generator to handle multiple snippets in the same dartdoc block
      properly.
      
      I also generated, compiled, and ran each of the existing application samples,
      and fixed them up to be more useful and/or just run without errors.
      
      This PR fixes these problems with examples:
      
      1. Switching tabs in a snippet now works if there is more than one snippet in
         a single dartdoc block.
      2. Generation of snippet code now works if there is more than one snippet.
      3. Contrast of text and links in the code sample block has been improved to
         recommended levels.
      4. Added five new snippet templates, including a "freeform" template to make
         it possible to show examples that need to change the app instantiation.
      5. Fixed several examples to run properly, a couple by adding the "Scaffold"
         widget to the template, a couple by just fixing their code.
      6. Fixed visual look of some of the samples when they run by placing many
         samples inside of a Scaffold.
      7. In order to make it easier to run locally, changed the sample analyzer to
         remove the contents of the supplied temp directory before running, since
         having files that hang around is problematic (only a problem when running
         locally with the `--temp` argument).
      8. Added a `SampleCheckerException` class, and handle sample checking
         exceptions more gracefully.
      9. Deprecated the old "## Sample code" designation, and added enforcement for
         the deprecation.
      10. Removed unnecessary `new` from templates (although they never appeared in
         the samples thanks to dartfmt, but still).
      
      Fixes #26398
      Fixes #27411
      262f12b4
  2. 06 Feb, 2019 1 commit
  3. 25 Jan, 2019 1 commit
    • Greg Spencer's avatar
      Modify offline docs platform family for Dash/Zeal (#27053) · 02dbb08c
      Greg Spencer authored
      This changes the DocSetPlatformFamily key to be "dartlang" instead of the name of the package (usually "flutter"). This is so that the IntelliJ plugin for Dash will be able to go directly to the docs for a symbol from a keystroke, instead of needing to search all the docsets each time.
      
      Without this, flutter isn't part of the list of package names it searches. After this, it finds the flutter docs because they're declared to be part of the "dartlang" family of docs.
      
      Dashing doesn't have a way to configure this, so we modify the Info.plist directly to make the change.
      02dbb08c
  4. 11 Dec, 2018 1 commit
  5. 28 Nov, 2018 1 commit
  6. 15 Nov, 2018 2 commits
  7. 14 Nov, 2018 1 commit
  8. 13 Nov, 2018 1 commit
  9. 12 Nov, 2018 1 commit
  10. 08 Nov, 2018 1 commit
  11. 07 Nov, 2018 1 commit
    • Greg Spencer's avatar
      Fixes several bugs in samples, quotes HTML properly, and pre-compiles snippet tool. (#24020) · 094f93df
      Greg Spencer authored
      When converting all of the samples to use the snippet tool, I encountered some bugs/shortcomings:
      
      1. The document production took 90 minutes, since the snippet tool was being invoked from the command line each time. I fixed this by snapshotting the executable before running, so it's down to 7 minutes.
      
      2. The sample code was not being properly escaped by the snippet tool, so generics were causing issues in the HTML output. It is now quoted.
      
      3. Code examples that used languages other than Dart were not supported. Anything that highlight.js was compiled for dartdoc with is now supported.
      
      4. The comment color for highlight.js was light grey on white, which was pretty unreadable. It's now dark green and bold.
      094f93df
  12. 23 Oct, 2018 1 commit
    • Greg Spencer's avatar
      Dartdoc snippet extension to inject full featured code snippets in to API docs. (#23281) · 65d3ddd5
      Greg Spencer authored
      This creates a custom dartdoc tool that will generate snippet blocks in our API docs that allow the user to copy easily to the clipboard, and will also embed the snippet code into a template to show it in a larger context with an app.
      
      This PR adds the snippet tool, a template, and a couple of HTML skeleton files, one for snippets that are designed to be in an application setting, and one where it simply puts a nice container around existing snippets, making them easier to copy to the clipboard.
      65d3ddd5
  13. 25 Sep, 2018 1 commit
  14. 23 Sep, 2018 1 commit
  15. 26 Apr, 2018 1 commit
  16. 30 Mar, 2018 1 commit
  17. 19 Mar, 2018 1 commit
  18. 13 Feb, 2018 1 commit
  19. 02 Feb, 2018 1 commit
  20. 29 Nov, 2017 2 commits
    • Matt Sullivan's avatar
      Add survey js to docs web site (#13210) · f44007c8
      Matt Sullivan authored
      * Fixed typo in navigator.dart doc comments
      
      * Added survey js to docs template
      f44007c8
    • Greg Spencer's avatar
      Consolidating .gitignore files. (#13002) · 909406ba
      Greg Spencer authored
      This consolidates all of the non-template .gitignore rules into the top level .gitignore, to ignore common things more broadly, with less maintenance needed for the .gitignore files. Does not touch the templates, so that they still produce needed .gitignores as part of flutter create.
      909406ba
  21. 13 Oct, 2017 1 commit
  22. 15 Aug, 2017 1 commit
  23. 26 Jun, 2017 1 commit
  24. 26 May, 2017 1 commit
  25. 25 May, 2017 1 commit
  26. 22 May, 2017 1 commit
  27. 14 Apr, 2017 1 commit
  28. 10 Feb, 2017 1 commit
  29. 09 Nov, 2016 2 commits
  30. 01 Aug, 2016 1 commit
    • Seth Ladd's avatar
      Docs colors logo (#5176) · b34b453c
      Seth Ladd authored
      * update the color and logo for the docs site
      
      * update the color and logo for the docs site
      
      * remove unused file
      
      * removed unused script code
      
      * tweak styles for inherited names
      b34b453c
  31. 23 Jul, 2016 1 commit
  32. 12 Jul, 2016 1 commit
    • Seth Ladd's avatar
      Firebase hosting for docs (#4871) · 1ac08b26
      Seth Ladd authored
      * configs for firebase hosting
      
      * use the implicit FIREBASE_TOKEN
      
      * don't print every command (lowers the chance of printing secret env vars, and for realz only deploy when merging into master
      1ac08b26
  33. 16 May, 2016 1 commit
    • Seth Ladd's avatar
      Docs homepage (#3908) · 707fe582
      Seth Ladd authored
      * put an index at root of API docs bucket
      
      * ignore all of dev/docs/doc dir, fix a bug, remove private names from doc gen script
      
      * tweaks from review
      707fe582
  34. 13 May, 2016 1 commit
  35. 16 Apr, 2016 1 commit
  36. 13 Apr, 2016 1 commit
  37. 12 Apr, 2016 1 commit