Skip to content

Commit

Permalink
Misc doc changes (#117)
Browse files Browse the repository at this point in the history
List of changes:

- Always use the latest ex_doc
- Sort deps
- Add source reference
- Set readme as default html page
- Add changelog to html doc
- Fix typos, indentation, and markdowns
- Update .gitignore
- Add editorconfig file
- Add license section
- Add project description section
  • Loading branch information
kianmeng committed Nov 29, 2020
1 parent f0981b9 commit 98dcee5
Show file tree
Hide file tree
Showing 27 changed files with 275 additions and 3,689 deletions.
21 changes: 21 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# EditorConfig is awesome: http://EditorConfig.org

# .editorconfig for Elixir projects
# https://git.io/elixir-editorconfig

# top-most EditorConfig file
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.{md, markdown, eex}]
trim_trailing_whitespace = false

[Makefile]
indent_style = tab
29 changes: 24 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,26 @@
/_build
/cover
/deps
# The directory Mix will write compiled artifacts to.
/_build/

# If you run "mix test --cover", coverage assets end up here.
/cover/

# The directory Mix downloads your dependencies sources to.
/deps/

# Where third-party dependencies like ExDoc output generated docs.
/doc/

# Ignore .fetch files in case you like to edit your project deps locally.
/.fetch

# If the VM crashes, it generates a dump, let's ignore it too.
erl_crash.dump

# Also ignore archive artifacts (built via "mix archive.build").
*.ez
.elixir_ls
.tool-versions

# Ignore package tarball (built via "mix hex.build").
paper_trail-*.tar

# Temporary files for e.g. tests
/tmp
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Changelog

### v0.8.3 - September 10th, 2019:
- PaperTrail.delete now accepts Ecto.Changeset

Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The MIT License (MIT)
Copyright (c) 2016 Izel Nakri
Copyright (c) 2016-present Izel Nakri

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
386 changes: 200 additions & 186 deletions README.md

Large diffs are not rendered by default.

19 changes: 0 additions & 19 deletions doc/.build

This file was deleted.

123 changes: 0 additions & 123 deletions doc/404.html

This file was deleted.

180 changes: 0 additions & 180 deletions doc/Mix.Tasks.Papertrail.Install.html

This file was deleted.

Loading

0 comments on commit 98dcee5

Please sign in to comment.