소스 검색

Add performance note to hacking docs.

Brit Butler 11 년 전
부모
커밋
2268516412
1개의 변경된 파일15개의 추가작업 그리고 0개의 파일을 삭제
  1. 15 0
      docs/hacking.md

+ 15 - 0
docs/hacking.md

@@ -23,6 +23,18 @@ Conceptually, coleslaw processes a blog as follows:
23 23
     staging directory. It does whatever work is needed to make the
24 24
     generated HTML files (and any static content) visible to the web.
25 25
 
26
+## A Note on Performance
27
+
28
+A recent test on my Core i5 touting Thinkpad generated my 430-post blog
29
+in 2.7 seconds. This averages out to about 6-7 milliseconds per piece of
30
+content. However, about 400 of those 430 items were HTML posts from a
31
+wordpress export, not markdown posts that require parsing with 3bmd.
32
+I expect that 3bmd would be the main bottleneck on a larger site. It
33
+would be worthwhile to see how well [cl-markdown][clmd] performs as
34
+a replacement if this becomes an issue for users though we would lose
35
+source highlighting from [colorize][clrz] and should also investigate
36
+[pygments][pyg] as a replacement.
37
+
26 38
 ## Core Concepts
27 39
 
28 40
 ### Data and Deployment
@@ -253,3 +265,6 @@ simply disabling the indexes may be appropriate for certain users.
253 265
 [post_receive_hook]: https://github.com/redline6561/coleslaw/blob/master/examples/example.post-receive
254 266
 [closure_template]: https://github.com/archimag/cl-closure-template
255 267
 [api_docs]: https://github.com/redline6561/coleslaw/blob/master/docs/plugin-api.md
268
+[clmd]: https://github.com/gwkkwg/cl-markdown
269
+[clrz]: https://github.com/redline6561/colorize
270
+[pyg]: http://pygments.org/