@@ -19,6 +19,10 @@ For an example of generated documentation,
1919> Output is currently limited to CommonMark,
2020> but the plan is to support HTML and other formats as well.
2121
22+ ## Requirements
23+
24+ - Swift 5.2
25+
2226## Command-Line Utility
2327
2428` swift-doc ` can be used from the command-line on macOS and Linux.
@@ -282,48 +286,6 @@ generating HTML, CSS, and a search index instead of just text.
282286Compare its [ generated HTML output] [ jazzy swiftsemantics ]
283287to [ a GitHub wiki generated with ` swift-doc ` ] [ swift-doc swiftsemantics ] .
284288
285- ## What About [ SwiftDoc.org] [ swiftdoc.org ] ?
286-
287- ** tl;dr:**
288- SwiftDoc.org is now updated for Swift 5.1,
289- but we're still working to migrate over a few missing parts
290- (notably, the beloved
291- [ type inheritance graphs] ( https://swiftdoc.org/v4.2/protocol/expressiblebyfloatliteral/hierarchy/ ) ).
292-
293- SwiftDoc.org,
294- [ originally "Swifter"] ( http://natecook.com/blog/2014/09/introducing-swifter/ ) ,
295- was created by Nate Cook ([ @natecook1000 ] [ @natecook1000 ] )
296- in September 2014.
297- At the time,
298- Swift tooling was still in its infancy,
299- so Nate actually
300- [ wrote a parser (from scratch!)] ( https://github.com/SwiftDocOrg/swiftdoc-parser )
301- to pull symbols and documentation from the Swift standard library.
302- Nate became managing editor of [ NSHipster] [ nshipster ] in 2015,
303- bringing SwiftDoc with him as an affiliated project.
304- When Mattt took over NSHipster duties for Nate in 2018,
305- he inherited SwiftDoc along with it.
306-
307- After the hand-off,
308- we were able to get the site updated for Swift 4.2 without too much trouble.
309- But when it came time to regenerate the site for Swift 5,
310- we found ourselves deep in [ "dependency hell"] [ dependency hell ]
311- (something to do with the [ regular expression] [ pcre ] library
312- that Nate had used for the parser).
313- After begging and pleading with
314- the spirits possessing our ` node_modules ` directory to no avail,
315- we decided to roll up our sleeves and get started on a long-term replacement —
316- this time, written in Swift.
317-
318- _ Thanks for all of your encouragement about the site over the years
319- and your patience throughout this whole process.
320- We're sorry it took so long to get around to getting it updated,
321- but we hope this all will have been worth the wait!_ 🙇♂️
322-
323- ## Project Roadmap
324-
325- _ (Coming soon!)_
326-
327289## License
328290
329291MIT
0 commit comments